Skip to content

Commit ef58143

Browse files
committed
disable section lines in docstrings (we use google convention)
1 parent 93c4680 commit ef58143

4 files changed

Lines changed: 1 addition & 11 deletions

File tree

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ version_variable = "src/somesy/__init__.py:__version__"
128128

129129
[tool.ruff.lint]
130130
extend-select = ["I", "D", "B", "S", "W"]
131-
ignore = ["D203", "D213", "B008"]
131+
ignore = ["D203", "D213", "D407", "B008"]
132132

133133
[tool.ruff.lint.per-file-ignores]
134134
"**/{tests,docs}/*" = ["ALL"]

src/somesy/commands/init_config.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ def init_config(input_path: Path, options: dict) -> None:
1414
"""Initialize somesy configuration file.
1515
1616
Args:
17-
----
1817
input_path (Path): Path to somesy file (will be created/overwritten).
1918
options (dict): CLI options.
2019
"""

src/somesy/commands/sync.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ def _sync_python(
4646
"""Sync pyproject.toml file using project metadata.
4747
4848
Args:
49-
----
5049
metadata (ProjectMetadata): project metadata to sync pyproject.toml file.
5150
pyproject_file (Path, optional): pyproject file to read project metadata from.
5251
"""
@@ -65,7 +64,6 @@ def _sync_cff(
6564
"""Sync CITATION.cff file using project metadata.
6665
6766
Args:
68-
----
6967
metadata (ProjectMetadata): project metadata to sync pyproject.toml file.
7068
cff_file (Path, optional): CFF file path if wanted to be synced. Defaults to None.
7169
"""
@@ -84,7 +82,6 @@ def _sync_package_json(
8482
"""Sync package.json file using project metadata.
8583
8684
Args:
87-
----
8885
metadata (ProjectMetadata): project metadata to sync pyproject.toml file.
8986
package_json_file (Path, optional): package.json file path if wanted to be synced. Defaults to None.
9087
"""

src/somesy/core/core.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,12 @@ def discover_input(input_file: Optional[Path] = None) -> Path:
1616
"""Check given input file path. If not given, find somesy configuration file path from default list.
1717
1818
Args:
19-
----
2019
input_file: somesy configuration file path. Defaults to None.
2120
2221
Raises:
23-
------
2422
FileNotFoundError: Raised if no somesy input file found from cli input or the defaults.
2523
2624
Returns:
27-
-------
2825
somesy configuration file path.
2926
"""
3027
if input_file:
@@ -57,16 +54,13 @@ def get_input_content(path: Path, *, no_unwrap: bool = False) -> Dict[str, Any]:
5754
The function checks if the file is a valid somesy input file by checking its name and content.
5855
5956
Args:
60-
----
6157
path (Path): path to the input file
6258
no_unwrap (bool): if True, the function returns the TOMLDocument object instead of unwrapping it
6359
6460
Returns:
65-
-------
6661
the content of the input file as a TOMLDocument object
6762
6863
Raises:
69-
------
7064
ValueError: if the input file is not a valid somesy input file or if the file is not a TOML file.
7165
RuntimeError: if the input file does not contain a somesy input section at expected key
7266
"""

0 commit comments

Comments
 (0)