Sphinx documentation questions
I have some outstanding questions about small details in the Sphinx docs and am not sure how best to address them.
-
In the ha-continue.json file, it says
"description": "See <xref linkend=\"anchor-in-the-docs\"/>",
. I assume that should actually refer to a real anchor, right? I've changed it to"description": "See <xref linkend=\"command-ha-continue\"/>",
but if that's not correct please let me know. -
In remote-option4-global-get.json and remote-option6-global-get.json, it says:
"resp-syntax": [
"{",
" \"result\": 0,",
" \"text\": \"DHCPv4 option in found.\",",
Is that supposed to say IS found rather than IN found? I'm assuming yes and changing the text, but please let me know if that's not correct.
Related question: is there any way to verify that the results that we describe in the ARM are the actual results that people will see?
-
In subnet4-del.json and subnet6-del.json, the brief description says "This command has no effect on other configured subnets, but removing a subnet has certain implications which the server's administrator should be aware of." Should we include any information about what those implications are, or where users should look to find them?
-
In lease6-bulk-apply.json, The
cmd-comment
saysThe \"deleted-leases\" and \"leases\" are optional parameters, but one of them must be specified."
Does that mean that you need one or the other but not both? It's unclear from the wording.