From 7e3873439823ba2424378c409910c898544b1021 Mon Sep 17 00:00:00 2001 From: Lisa Julia Nebel Date: Mon, 24 Jun 2024 16:30:52 +0200 Subject: [PATCH] Rename function in sphinx_ext_docstrings.py to snake_case --- .../src/opm_simulators_docs/sphinx_ext_docstrings.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/python/sphinx_docs/src/opm_simulators_docs/sphinx_ext_docstrings.py b/python/sphinx_docs/src/opm_simulators_docs/sphinx_ext_docstrings.py index e9517719481..32418f13d5a 100644 --- a/python/sphinx_docs/src/opm_simulators_docs/sphinx_ext_docstrings.py +++ b/python/sphinx_docs/src/opm_simulators_docs/sphinx_ext_docstrings.py @@ -4,7 +4,7 @@ from sphinx.util.docutils import SphinxDirective from docutils import nodes -def readDocStrings(directive, docstrings_path): +def read_doc_strings(directive, docstrings_path): print(docstrings_path) with open(docstrings_path, 'r') as file: docstrings = json.load(file) @@ -42,7 +42,7 @@ class SimulatorsDirective(SphinxDirective): option_spec = {} def run(self): - return readDocStrings(self, self.state.document.settings.env.app.config.opm_simulators_docstrings_path) + return read_doc_strings(self, self.state.document.settings.env.app.config.opm_simulators_docstrings_path) class CommonDirective(SphinxDirective): required_arguments = 0 @@ -51,7 +51,7 @@ class CommonDirective(SphinxDirective): option_spec = {} def run(self): - return readDocStrings(self, self.state.document.settings.env.app.config.opm_common_docstrings_path) + return read_doc_strings(self, self.state.document.settings.env.app.config.opm_common_docstrings_path) def setup(app): app.add_config_value('opm_simulators_docstrings_path', None, 'env')