-
Notifications
You must be signed in to change notification settings - Fork 37
docs/overlaps: Add 'Changing the location' section #2060
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
base: master
Are you sure you want to change the base?
docs/overlaps: Add 'Changing the location' section #2060
Conversation
shymega-ct
commented
Sep 15, 2025
- This adds a section about configuring some Element kinds for staging their dependencies in certain locations.
- This adds a section about configuring some Element kinds for staging their dependencies in certain locations.
cd90dae to
ca6e3b6
Compare
| This would cause later builds of ``runtime-only.bst`` to no longer | ||
| conflict on the given file. | ||
|
|
||
| Changing the location |
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.
This section doesn't fit with the rest of the document. The document discusses an example project, while this section discusses a theoretical example that isn't well defined.
I'm not sure what's the best way to deal with this. Extend the example project so that this can be applied? That could be too complicated for this tutorial. Move it to somewhere else in the documentation? I don't know where that could be.
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 agree that it doesn't /really/ fit with the rest of the document. I
looked through the docs to find an alternative place, but none felt
like a good place.
I guess we could just keep the section in BuildElement and refer to
that from other documentation?
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.
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 guess we could just keep the section in BuildElement and refer to
that from other documentation?
Yes, I think it would be reasonable to add the information from this section to the BuildElement documentation as that's where location is documented. That said, the BuildElement documentation is a bit hidden as it's part of the Plugin API reference even though location is more relevant to project developers than plugin developers. I.e., maybe we could find a better place for the whole location documentation. However, moving that around is not directly related to expanding the documentation to cover the handling of runtime dependencies, so I suggest to first land the expanded documentation in BuildElement and then separately consider moving that section to a more relevant/discoverable part of the documentation.
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 believe it is also, separately documented in ScriptElement right ?
There are a couple (slowly growing number) of features which cannot be directly implemented on the Element class but are common amongst abstract subclasses, it can perhaps make sense perhaps to add a page to consolidate documentation for these common features on a single page...