spdx
Include derived classes in Documentation
Based on feedback from users reading the SPDX 3 documentation, it would be helpful if classes listed other classes derived from them in addition to their parent classes. This is particularly helpful for abstract classes, where it may not be apparent what concrete class should be used when a user is navigating the documentation
DIscussed in call today, and general concensus that first level down would be reasonable. If web technologies permit, full enumeration would be best, but starting with first level would help with issues raised.
List of Derived classes would be helpful. Agent is an example. Should be made explicit it was a Person, Tool, Org, etc.
From discussion - at least direct children; but ideally the full tree of children would be best.
Of course, the full tree of children would mean that Element class will have a list of (mostly) everything else.
Not yet.
See
- 3.0 https://spdx.github.io/spdx-spec/v3.0.1/model/Software/Classes/Package/
- 3.1 https://spdx.github.io/spdx-spec/v3.1-dev/model/Software/Classes/Package/
