MCPcopy Create free account
hub / github.com/SeleniumHQ/selenium / generate_doc

Method generate_doc

py/generate.py:520–533  ·  view source on GitHub ↗

Generate the docstring for this parameter.

(self)

Source from the content-addressed store, hash-verified

518 return code
519
520 def generate_doc(self):
521 """Generate the docstring for this parameter."""
522 doc = f":param {self.py_name}:"
523
524 if self.experimental:
525 doc += " **(EXPERIMENTAL)**"
526
527 if self.optional:
528 doc += " *(Optional)*"
529
530 if self.description:
531 desc = self.description.replace("`", "``").replace("\n", " ")
532 doc += f" {desc}"
533 return doc
534
535 def generate_from_json(self, dict_):
536 """Generate the code to instantiate this parameter from a JSON dict."""

Callers

nothing calls this directly

Calls

no outgoing calls

Tested by

no test coverage detected