-
Notifications
You must be signed in to change notification settings - Fork 6
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
Ecalc 1687 docs tests coupling #738
Conversation
add alias plugin for docusaurus to make the imports neater
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Now it should be easy to add a test that makes sure our examples does not have invalid results!
I didn't look at the yaml changes or snapshot changes 👀
'docusaurus-plugin-module-alias', | ||
{ | ||
alias: { | ||
'@examples': resolve(__dirname, '../src/libecalc/examples/'), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI. I first tried to implement the webpack alias as a small custom plugin (in its own folder/files) to avoid 3rd party dependency. But that did not work. I then tried this plugin and it worked as intended.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just updated the snapshot for that one test since it failed after the changes. I am not sure how to validate if it is correct or not? (or if its just fine to update the snapshot when other tests passes?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice. @frodehk what you think? you are more into this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work!
The yaml changes (advanced model) are in line with the last update of the advanced model, as far as I can see. Including an update with CONTROL_MARGIN for required components. |
Have you remembered and considered?
docs/drafts/next.draft.md
)docs/docs/migration_guides/
)BREAKING:
in footer or!
in header, if breakingECALC-XXXX
)Why is this pull request needed?
Organization of tests and coupling between docs and tests to avoid redundancy of example test data and to assure example cases in docs are tested.
What does this pull request change?
Issues related to this change:
ECALC-1687