writer icon indicating copy to clipboard operation
writer copied to clipboard

Ability to change doc grammer style

Open rickdonato opened this issue 3 years ago • 3 comments
trafficstars

Sometimes the docs creating docs like:

    # Getting the platform and name of the host from the Nornir inventory.
    platform = nr.inventory.hosts[f"{task.host}"].platform
    device_name = nr.inventory.hosts[f"{task.host}"].name

    # Creating a naming object.
    defs = naming.Naming(DEF_DIR)

It would be great to have an option which allowed only singular present tense to be used for example:

    # Get the platform and name of the host from the Nornir inventory.
    platform = nr.inventory.hosts[f"{task.host}"].platform
    device_name = nr.inventory.hosts[f"{task.host}"].name

    # Create a naming object.
    defs = naming.Naming(DEF_DIR)

Is there an option for this or is this something that could be added.

Many Thanks,

rickdonato avatar Jul 22 '22 10:07 rickdonato

Interested to know. What are your thoughts on this?

rickdonato avatar Aug 10 '22 11:08 rickdonato

It would be better if you can customize the specific details of each style, similar to the koroFileHeader plugin image

wb2712 avatar Jan 30 '23 07:01 wb2712

I usually use doxywizard.exe to generate documents, but the annotation content automatically generated by AI is inconsistent with my expected format, and needs to be changed one by one

wb2712 avatar Jan 30 '23 07:01 wb2712