-
-
Notifications
You must be signed in to change notification settings - Fork 280
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
Update pinning_deps.rst #1348
base: main
Are you sure you want to change the base?
Update pinning_deps.rst #1348
Conversation
Added information about what the pins mean
cc @conda-forge/core We'll need to go through this one carefully before merging. |
Improved the contents of some definitions
src/maintainer/pinning_deps.rst
Outdated
ABIs and the conda-forge-pinning feedstock | ||
========================================== | ||
|
||
conda-forge pinning can be expounded in terms of ABIs (Application Binary Interface), that is, as some programs require specific versions of some API libraries to function correctly - so do some packages require specific versions of some ABIs to function correctly, which is why some libraries used within the conda-forge feedstock are specific to some particular ABI versions. |
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.
@bashirk Would you mind rewriting this paragraph, I needed to read twice to comprehend.
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.
Great! I'll work on rewriting this to be as comprehensive as possible.
Many thanks for the feedback.
src/maintainer/pinning_deps.rst
Outdated
|
||
Pins, generally, are all about setting benchmarked versions of packages or libraries that serve as dependencies for some other packages or libraries, just so these dependent packages behave as much as the author(s) of the dependent packages would want them to behave. | ||
|
||
So conda-forge pins are about declaring the standard version (a specific version) of a package dependency that conda-forge or a `conda recipe <https://github.com/conda-forge/staged-recipes>`_ supports, and how recipes that depend on some specific version of some libraries are set in order to not use other varying versions of the dependency. |
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.
can you add this link https://conda-forge.org/blog/posts/2020-10-02-versions/ has an more outstanding overview of how conda-forge handles the pinning process?
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.
Awesome! I'll do that.
Many thanks for the input.
Updated contents of the file to include modifications - as directed by reviewer.
Added information about what the pins mean
PR Checklist:
make all edits to the docs in the
src
directory, not indocs
note any issues closed by this PR with closing keywords
put any other relevant information below
Added documentation on what the pins mean
Related issue: Add docs about what the pins mean #909