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

Wording issues #42

Open
flycoolman opened this issue Dec 24, 2024 · 0 comments
Open

Wording issues #42

flycoolman opened this issue Dec 24, 2024 · 0 comments

Comments

@flycoolman
Copy link
Contributor

(1) Sec 3.1, “Query Parameters for a Targeted List or Leaf-list”
Insert the word “in” to change “presented this section” to “presented in
this section”.
Also, remove the double quotes from ““the”, to change “and lastly “the
“limit” parameter” to “and lastly the “limit” parameter”.

(2) Sec 3.1.3, “The “locale” Query Parameter”
Insert the word “to” to change “the server select a locale” to “the server
to select a locale”.

(3) Sec 3.1.5, “The “offset” Query Parameter”
Insert the word “the” to change “result-set are skipped, same as
when” to “result-set are skipped, the same as when”.

(4) Sec 3.1.6, “The “cursor” Query Parameter”
When the text says “It is an error to supply an unknown cursor”, would it
be clearer to say “It is an error to supply an unknown cursor value”?
Also, remove the word “the” to change “is not relevant for the leaf-lists”
to “is not relevant for leaf-lists”.

(5) Sec 3.3, “Constraints on “where” and “sort-by” for “config false”
Lists”
Move the word “already” to change “is not considered as already servers
must be able to process them” to “is not considered as servers must already
be able to process them”.

(6) Sec 4.1, “Data Model Overview”
Correct the word “leafs” to change “three optional leafs” to “three
optional leaves”.

(7) Yang model: The “remaining” annotation
Insert the word “the” to change “Indicates that number of remaining
entries” to “Indicates that the number of remaining entries”.

(8) Yang model: The “sort-by-param-grouping” grouping
The regular expression does not technically encode an RFC 7950
‘descendant-schema-nodeid’. It fails to enforce at least one character for
the identifier, and it fails to put restrictions on the first character in
an identifier.
The correct pattern is
([a-zA-Z_][0-9a-zA-Z.-]*:)?[a-zA-Z][0-9a-zA-Z.-]*(/([a-zA-Z][0-9a-zA-Z.-]*:)?[a-zA-Z][0-9a-zA-Z._-])

(9) Yang model: The augmentation for the per-node-capabilities
Correct “leafs” to change “Defines some leafs that MAY be used” to
“Defines some leaves that MAY be used”

(10) Appendix A.1, example model:
/members/member/privacy-settings/post-visibility
Correct “visable” to change “though visable to all” to “though visible to
all”.

(10) Appendix A.1, example model: /members/member/following
Change “Other members this members is following” to “Other members this
member is following”.

(11) Appendix A.1, example model: /members/member/favorites/int64-numbers
Correct “uint64” (on the int64 leaf) to change “The member’s favorite
uint64 numbers.” to “The member’s favorite int64 numbers.”

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant