Skip to content
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

Extend HTML documentation of base classes for overrides #1057

Closed
Tracked by #107
prjemian opened this issue Jun 13, 2022 · 6 comments
Closed
Tracked by #107

Extend HTML documentation of base classes for overrides #1057

prjemian opened this issue Jun 13, 2022 · 6 comments

Comments

@prjemian
Copy link
Contributor

prjemian commented Jun 13, 2022

HTML documentation pages always reference nicely the base class of each group in a definition file, but it references only the most basic base class! Eg. NXarpes/instrument/source/ references NXsource, but not NXinstrument/NXsource (which may have already extended/overridden NXsource)

@prjemian prjemian changed the title HTML documentation pages always reference nicely the base class of each group in a definition file, but it references only the most basic base class! Eg. NXarpes/instrument/source/ references NXsource, but not NXinstrument/NXsource (which may have already extended/overridden NXsource) Extend HTML documentation of base classes for overrides Jun 13, 2022
@prjemian prjemian transferred this issue from nexusformat/NIAC Jun 13, 2022
@prjemian prjemian added this to the NXDL 2022.06 milestone Jun 13, 2022
@PeterC-DLS PeterC-DLS self-assigned this Jun 16, 2022
@PeterC-DLS
Copy link
Contributor

PeterC-DLS commented Jun 17, 2022

@prjemian Do you meant reference, eg. NXsource, within the application definition?

@prjemian
Copy link
Contributor Author

@PeterC-DLS Will this issue be resolved in the next days? Is it necessary to resolve this for release of NXDL now?

@PeterC-DLS
Copy link
Contributor

Not sure if I have time to do this before release, so I'm happy to postpone it.

@prjemian prjemian modified the milestones: NXDL 2022.06, NXDL 2023.06 Jun 24, 2022
@prjemian
Copy link
Contributor Author

@prjemian Do you meant reference, eg. NXsource, within the application definition?

Yes. When an application definition overrides a base class and then, in another part of the application definition, refers to that override, the documentation we build point to the override as it is used.

@sanbrock can provide deeper explanation.

@sanbrock
Copy link
Contributor

A solution to this problem is to add a direct link to the vocabulary item referenced first. E.g.: NXXkappa/ENTRY/definition
definition: (required) NX_CHAR <NXxbase/…/definition>
This is implemented in the PR #1272

@sanbrock sanbrock linked a pull request Jun 15, 2023 that will close this issue
@sanbrock
Copy link
Contributor

Similarly, for NXxkappa/entry we should indicate that although its base class type is NXentry, it is actually extending NXxbase/entry, which is already an extended NXentry. We should provide this information by linking the first reference, and not only the very base reference. Hence, it should look like:
entry: (required) NXentry <NXxbase/entry>

@PeterC-DLS PeterC-DLS modified the milestones: NXDL 2023.06, NXDL 2023.10 Jan 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging a pull request may close this issue.

3 participants