docs: clarify the behavior of includes #1532
Merged
Conversation
This file contains 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
frostming
reviewed
Nov 25, 2022
gsalvatella
force-pushed
the
docs/includes
branch
from
facd5c5 to
c16a332
Compare
|
@frostming Another interesting option would be to consider adding code block annotations. This is a great example of them being useful to not clutter the main text with admonitions and clarifications. Would you fancy the idea? |
The behavior of `includes` seems to imply that any files listed will be *added* to the package itself. However the latter has to be also explicitly included. This can cause confusion when adding `includes` for the first time in an already existing package, whereby the package itself will suddenly disappear from the build. Clarify this in the documentaion. Fixes pdm-project#1531
gsalvatella
force-pushed
the
docs/includes
branch
from
c16a332 to
241a62f
Compare
Good idea, i didn't know that plugin before |
Merged
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.
The behavior of
includesseems to imply that any files listed will be added to the package itself. However the latter has to be also explicitly included. This can cause confusion when addingincludesfor the first time in an already existing package, whereby the package itself will suddenly disappear from the build. Clarify this in the documentaion.Fixes #1531
Pull Request Check List
news/describing what is new. N/ADescribe what you have changed in this PR.