Add some documentation about subset collections#885
Merged
tmadlener merged 2 commits intoAIDASoft:masterfrom Nov 28, 2025
Merged
Add some documentation about subset collections#885tmadlener merged 2 commits intoAIDASoft:masterfrom
tmadlener merged 2 commits intoAIDASoft:masterfrom
Conversation
Collaborator
|
Thanks a lot. I think it might fit better here: https://github.com/AIDASoft/podio/blob/master/doc/examples.md as advanced topic is quite far down the sidebar on the documentation page. |
Member
Author
|
It's long enough (and even with a subsection about limitations) that I don't think it fits in the examples. The example that is in this PR could be added there maybe, I think that would fit better the existing examples there. |
Collaborator
|
Fair point. Can we get a short intro and the example into the examples and a link from there to the advanced topics with the limitations? |
Member
Author
|
Added the small example but left the part in advanced topics untouched, is that what you meant? |
Collaborator
|
Yes, exactly. Thank you :) |
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
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.
BEGINRELEASENOTES
ENDRELEASENOTES
I didn't see a clear place to put it and it is short enough that it doesn't deserve its own section. I don't add an example in examples.md to avoid duplication. The only documentation that seems to exist now is in https://key4hep.github.io/key4hep-doc/main/how-tos/key4hep-tutorials/edm4hep_analysis/edm4hep_api_intro.html#subset-collections.
Close #858.