Skip to content

Commit

Permalink
correct documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sebaszm committed May 8, 2024
1 parent b7ab136 commit 6b5e4bf
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion JsonGenerator/source/documentation_generator.py
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ def MethodDump(method, props, classname, section, header, is_notification=False,
props["result"]["description"] = props["summary"]

if "@lookup" in props:
MdParagraph("> The *%s* object index shell be passed within the designator, e.g. ``%s.1.%s%s``." % (props["@lookup"][2].lower(), classname, orig_method2.replace("::", "<%s>::" % props["@lookup"][2].lower()) , "@" + props["index"]["example"] if "index" in props else ""))
MdParagraph("> The *%s* instance ID shell be passed within the designator, e.g. ``%s.1.%s%s``." % (props["@lookup"][2].lower(), classname, orig_method2.replace("::", "<%s>::" % props["@lookup"][2].lower()) , "@" + props["index"]["example"] if "index" in props else ""))

if "index" in props:
if "name" not in props["index"] or "example" not in props["index"]:
Expand Down

0 comments on commit 6b5e4bf

Please sign in to comment.