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.

Sign up for GitHub

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

docs: fix --use-xpathhelper usage #328

Merged
merged 1 commit into from
Dec 1, 2023
+3 −3
Merged

docs: fix --use-xpathhelper usage #328

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
PyangBind adds a number of command-line options to Pyang:

* [Output options](#output-options) - `-o`, `--split-class-dir`
* [XPathHelper options](#xpathhelper) - `--use-xpath-helper`
* [XPathHelper options](#xpathhelper) - `--use-xpathhelper`
* [Extensions options](#extensions) - `--interesting-extension`
* [RPC options](#rpcs) -- `--build-rpcs`
* [Extended Methods](#extmethods) -- `--use-extmethods`
Expand Down Expand Up @@ -65,9 +65,9 @@ bgp_global_config = config.config()

## XPathHelper Options <a name="xpathhelper"></a>

If `--use-xpath-helper` is _not_ specified, then all XPATH references throughout the classes generated will act as strings - such that any element that relies in XPATH (`when`/`leaf-ref` statements etc.) will simply take on any value that they are set to.
If `--use-xpathhelper` is _not_ specified, then all XPATH references throughout the classes generated will act as strings - such that any element that relies in XPATH (`when`/`leaf-ref` statements etc.) will simply take on any value that they are set to.

When` --use-xpath-helper` is specified, then references to the `path_helper` object that is supplied at the time of class instantiation will be passed to all of the classes children. This object is then used to provide lookup capabilities for XPATH expressions. This behaviour is further documented in (the XPathHelper documentation](xpathhelper.md).
When` --use-xpathhelper` is specified, then references to the `path_helper` object that is supplied at the time of class instantiation will be passed to all of the classes children. This object is then used to provide lookup capabilities for XPATH expressions. This behaviour is further documented in (the XPathHelper documentation](xpathhelper.md).

## Extension Options

Expand Down