Home
last modified time | relevance | path

Searched refs:docstring (Results 1 – 6 of 6) sorted by relevance

/petsc/lib/petsc/bin/maint/petsclinter/petsclinter/classes/docs/ !
H A D_doc_section.py136 …def _check_macro_synopsis(self, linter: Linter, cursor: Cursor, docstring: PetscDocStringImpl, exp…
160 if not (len(explicit_synopsis) or docstring.Modifier.FLOATING in docstring.type_mod):
175 extent = docstring._attr['sowing_char_range']
176 macro_ident = docstring.make_source_range('M', extent[0], extent.start.line)
177 docstring.add_diagnostic(
178 docstring.make_diagnostic(
215 docstring.extent.view()
241 header_path = find_header(Path(str(docstring.extent.start.file)).parent)
249 docstring.add_diagnostic_from_source_range(
271 def check(self, linter: Linter, cursor: Cursor, docstring: PetscDocStringImpl) -> None:
[all …]
H A D_doc_section_base.py139 def check(self, docstring: PetscDocStringImpl, section: SectionImpl, loc: SourceRange) -> None:
160 docstring.add_diagnostic_from_source_range(Diagnostic.Kind.ERROR, diag, mess, loc)
335 …def _do_setup(self, docstring: PetscDocStringImpl, inspect_line: LineInspector[PetscDocStringImpl]…
354 docstring.make_source_range(possible_header, line, loc.start.line)
357 inspect_line(docstring, loc, line, verdict)
362 def setup(self, docstring: PetscDocStringImpl) -> None:
376 self._do_setup(docstring, lambda ds, loc, line, verdict: None)
431 def _check_required_section_found(self, docstring: PetscDocStringImpl) -> None:
442 docstring.add_diagnostic_from_source_range(
443 Diagnostic.Kind.ERROR, diag, mess, docstring.extent, highlight=False
[all …]
/petsc/lib/petsc/bin/maint/petsclinter/petsclinter/checks/ !
H A D_docs.py30 docstring = DocStringType(linter, cursor)
32 with DiagnosticManager.push_from(docstring.get_pragmas()):
33 for section in docstring.parse().sections:
34 section.check(linter, cursor, docstring)
/petsc/src/binding/petsc4py/docs/source/ !
H A Ddocumentation_standards.rst17 The first line of a class, function or method docstring must be a short
24 docstring. Valid strings are: "Not collective.", "Logically collective.",
76 docstring should appear (e.g. setters and getters should cross-refer).
81 End docstring with an empty line - "closing three quotation marks must be on a
H A Dapidoc.py92 def docstring(obj, fail=True): function
168 doc = docstring(function)
175 doc = docstring(method)
182 doc = docstring(datadescr)
258 lines.add = docstring(cls)
H A Dconf.py24 from sphinx.ext.napoleon.docstring import NumpyDocstring