Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v14 - Ready] Migration guide and fixes to history file #934

Merged
merged 34 commits into from
Jul 2, 2024

Conversation

TorkelE
Copy link
Member

@TorkelE TorkelE commented Jun 9, 2024

Right now I am creating the migration guide as a hidden page in the documentation, which then can link from e.g. the GitHub home page.

I will also go through the history file and add anything that was missed, fix formatting/writing errors, and improve parts that are a bit short.

docs/make.jl Show resolved Hide resolved
HISTORY.md Show resolved Hide resolved
HISTORY.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@TorkelE TorkelE changed the title [WIP] Migration guide and fixes to history file [v14 - Ready] Migration guide and fixes to history file Jun 10, 2024
Copy link
Member

@isaacsas isaacsas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest changing the "stable" links to V14 links once the V14 docs are posted. That we the links won't go out of date if we change around the docs later on.

HISTORY.md Outdated Show resolved Hide resolved
HISTORY.md Outdated Show resolved Hide resolved
HISTORY.md Outdated Show resolved Hide resolved
HISTORY.md Outdated Show resolved Hide resolved
HISTORY.md Outdated Show resolved Hide resolved
docs/src/v14_migration_guide.md Outdated Show resolved Hide resolved
docs/src/v14_migration_guide.md Outdated Show resolved Hide resolved
docs/src/v14_migration_guide.md Outdated Show resolved Hide resolved
docs/src/v14_migration_guide.md Outdated Show resolved Hide resolved
docs/src/v14_migration_guide.md Outdated Show resolved Hide resolved
TorkelE and others added 18 commits June 28, 2024 17:51
Co-authored-by: Sam Isaacson <[email protected]>
Co-authored-by: Sam Isaacson <[email protected]>
Co-authored-by: Sam Isaacson <[email protected]>
Co-authored-by: Sam Isaacson <[email protected]>
Co-authored-by: Sam Isaacson <[email protected]>
Co-authored-by: Sam Isaacson <[email protected]>
Co-authored-by: Sam Isaacson <[email protected]>
@TorkelE
Copy link
Member Author

TorkelE commented Jun 28, 2024

Updated. You are correct about completeness and convert, that was a miss-writing that is now corrected. You are also correct regarding the metadata, the full implementation is kept internal, and we only expose the noise_scaling, description, and misc metadata, each which has their own dedicated MTK-style getters.

@TorkelE TorkelE closed this Jul 1, 2024
@TorkelE TorkelE reopened this Jul 1, 2024
@TorkelE TorkelE merged commit ae7f623 into master Jul 2, 2024
6 checks passed
@TorkelE TorkelE deleted the migration_guide branch July 2, 2024 04:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants