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

Documentation should include augmentation links #426

Closed
111pontes opened this issue Mar 28, 2017 · 0 comments
Closed

Documentation should include augmentation links #426

111pontes opened this issue Mar 28, 2017 · 0 comments
Assignees

Comments

@111pontes
Copy link
Collaborator

Documentation for augmentations are included on the augmented model. However, there is a special case where a module defines an augmentation and also defines some data types. In that case, documentation is generated for the data types, but there's no indication of the augmented model. As an example, Cisco_IOS_XR_controller_optics_cfg augments the Cisco_IOS_XR_ifmgr_cfg module, but it only includes documentation about its data types . Having a link to the augmented model will improve usability.
If a module only includes augmentations, we should keep the current behavior for now.

@ghost ghost added the documentation label Mar 30, 2017
@ghost ghost assigned ygorelik Dec 14, 2017
ygorelik pushed a commit to ygorelik/ydk-gen that referenced this issue Dec 19, 2017
ygorelik pushed a commit to ygorelik/ydk-gen that referenced this issue Dec 20, 2017
ghost pushed a commit that referenced this issue Jan 2, 2018
@ghost ghost closed this as completed Feb 1, 2018
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants