Skip to content

Add some documentation about subset collections#885

Merged
tmadlener merged 2 commits intoAIDASoft:masterfrom
jmcarcell:add-docs
Nov 28, 2025
Merged

Add some documentation about subset collections#885
tmadlener merged 2 commits intoAIDASoft:masterfrom
jmcarcell:add-docs

Conversation

@jmcarcell
Copy link
Member

BEGINRELEASENOTES

  • Add some documentation about subset collections

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.

@tmadlener
Copy link
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.

@jmcarcell
Copy link
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.

@tmadlener
Copy link
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?

@jmcarcell
Copy link
Member Author

Added the small example but left the part in advanced topics untouched, is that what you meant?

@tmadlener
Copy link
Collaborator

Yes, exactly. Thank you :)

@tmadlener tmadlener enabled auto-merge (squash) November 28, 2025 10:07
@tmadlener tmadlener merged commit 28d4efb into AIDASoft:master Nov 28, 2025
27 of 28 checks passed
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.

Document basics of subset collections

2 participants