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

yang: handle description deviations #856

Open
troglobit opened this issue Dec 5, 2024 · 1 comment
Open

yang: handle description deviations #856

troglobit opened this issue Dec 5, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@troglobit
Copy link
Contributor

Occasionally we wish to make a deviation for a "description" of a leaf in a standard yang model, typically when our implementation has limitations. Keeping description up to date with the functionality we support is good as we can use the supported yang models (with deviations) as Infix documentation; and to do this in one place.

However, deviations for description is unfortunately not possible today, and waiting for a new yang version (1.2) is not realistic.
See the following reported yang issue for more info: Allow deviation for description.

What work-arounds do we have? @wkz mentioned extending yang with another meta-data(?), where we could write updated documentation. If that "field" exists, we could parse that instead (when compiling doc offline or when showing "help cmd" on target)

@troglobit troglobit converted this from a draft issue Dec 5, 2024
@troglobit troglobit added the documentation Improvements or additions to documentation label Dec 5, 2024
@troglobit troglobit added this to the FUTURE milestone Dec 5, 2024
@troglobit
Copy link
Contributor Author

CCB: We could have an extra YANG model that is added only for the yang-doc.html generation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

1 participant