docs: add guidance on dependency version range #586
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SMoraisAnsys
requested review from
greschd,
jorgepiloto,
RobPasMue,
MaxJPRey and
da1910
github-actions
bot
added
the
documentation
greschd
reviewed
Apr 17, 2025
greschd
reviewed
Apr 17, 2025
greschd
approved these changes
Apr 17, 2025
There was a problem hiding this comment.
Very nice, thanks for taking this on @SMoraisAnsys! I just left some optional suggestions.
da1910
reviewed
Apr 17, 2025
RobPasMue
reviewed
Apr 21, 2025
Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
|
Thanks @greschd @da1910 @RobPasMue for your feedback. I've removed the part about testing with minimum versions from this PR but that might be something to consider later on. |
MaxJPRey
approved these changes
Apr 22, 2025
jorgepiloto
approved these changes
Apr 23, 2025
There was a problem hiding this comment.
Thanks for documenting this, @SMoraisAnsys. Looks good to me.
github-actions bot
pushed a commit
that referenced
this pull request
Apr 23, 2025
* docs: add guidance on dependency version range * docs: fix vale warnings * Update doc/source/how-to/packaging.rst Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com> * refactor: update following reviews * docs: fix vale warning * docs: fix typo in code-block * docs: fix code block rendering --------- Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following the comments in #558 (comment)
This PR aims at adding guidance on dependencies version ranges. In particular it explains why upper limits should only be added when absolutely necessary. I'd like this PR to only focus on that point and have your feedback on it.
When I start updating the docs to handle the first bullet point in #558 comment, I'll edit with required changes (e.g. references to the section on why pinning versions in CI / CD).