You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If you understand the same convention around square brackets that I do, then the synopsis indicates to me that an argument is optional, when in fact one is required. Ideally just this?:
rfc <command> | <number>
If angle brackets above indicate user-provided argument then for consistency I would expect the same for sub-commands:
rfc search <query>
Along the same lines, if you don't bold the sync synopsis keywords, why do you underline the search synopsis keyword? Or vice-versa ...
The CURL environment variable description is not quite a sentence. Perhaps "Force the use of curl (default) or wget to retrieve RFC files"?
The text was updated successfully, but these errors were encountered:
I think this was because you can run rfc without argument, although it’s useless. I fixed it.
I removed the brackets in 1.
the arguments of the sync command are fixed words, while the one for search is a placeholder. In the source I used <query> for the placeholder and `week` or `month` for the fixed words. Would you expect all arguments to be underlined (or bold), even if they are of different “type”?
A couple of things look funny to me:
If you understand the same convention around square brackets that I do, then the synopsis indicates to me that an argument is optional, when in fact one is required. Ideally just this?:
rfc <command> | <number>
If angle brackets above indicate user-provided argument then for consistency I would expect the same for sub-commands:
rfc search <query>
Along the same lines, if you don't bold the
sync
synopsis keywords, why do you underline thesearch
synopsis keyword? Or vice-versa ...The CURL environment variable description is not quite a sentence. Perhaps "Force the use of curl (default) or wget to retrieve RFC files"?
The text was updated successfully, but these errors were encountered: