Skip to content

Conversation

@shymega-ct
Copy link
Contributor

  • 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.
@shymega-ct shymega-ct force-pushed the domrodriguez/add-overlaps_bst-doc branch from cd90dae to ca6e3b6 Compare September 15, 2025 20:01
This would cause later builds of ``runtime-only.bst`` to no longer
conflict on the given file.

Changing the location
Copy link
Contributor

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.

Copy link
Contributor Author

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@juergbi @gtristan What are your thoughts on a good way to place this section in the docs?

Copy link
Contributor

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.

Copy link
Contributor

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...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants