standardize packaging, tooling, docs, CI, and licensing
This commit is contained in:
@@ -2,11 +2,9 @@ from docforge import GriffeLoader
|
||||
|
||||
|
||||
def test_alias_does_not_crash(temp_package):
|
||||
(temp_package / "alias.py").write_text(
|
||||
'''from typing import List
|
||||
(temp_package / "alias.py").write_text("""from typing import List
|
||||
Alias = List[int]
|
||||
'''
|
||||
)
|
||||
""")
|
||||
|
||||
loader = GriffeLoader()
|
||||
project = loader.load_project(["testpkg.alias"])
|
||||
|
||||
@@ -2,15 +2,13 @@ from docforge import GriffeLoader
|
||||
|
||||
|
||||
def test_class_and_methods(temp_package):
|
||||
(temp_package / "cls.py").write_text(
|
||||
'''class MyClass:
|
||||
(temp_package / "cls.py").write_text('''class MyClass:
|
||||
"""Class doc."""
|
||||
|
||||
def method(self, x: int) -> int:
|
||||
"""Method doc."""
|
||||
return x
|
||||
'''
|
||||
)
|
||||
''')
|
||||
|
||||
loader = GriffeLoader()
|
||||
project = loader.load_project(["testpkg.cls"])
|
||||
|
||||
@@ -2,12 +2,10 @@ from docforge import GriffeLoader
|
||||
|
||||
|
||||
def test_function_signature(temp_package):
|
||||
(temp_package / "fn.py").write_text(
|
||||
'''def add(a: int, b: int = 1) -> int:
|
||||
(temp_package / "fn.py").write_text('''def add(a: int, b: int = 1) -> int:
|
||||
"""Adds numbers."""
|
||||
return a + b
|
||||
'''
|
||||
)
|
||||
''')
|
||||
|
||||
loader = GriffeLoader()
|
||||
project = loader.load_project(["testpkg.fn"])
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import pytest
|
||||
|
||||
from docforge import GriffeLoader
|
||||
|
||||
|
||||
@@ -6,9 +7,8 @@ def test_load_project_raises_on_missing_module_by_default():
|
||||
loader = GriffeLoader()
|
||||
|
||||
with pytest.raises(ImportError):
|
||||
loader.load_project(
|
||||
["nonexistent.module", "sys"]
|
||||
)
|
||||
loader.load_project(["nonexistent.module", "sys"])
|
||||
|
||||
|
||||
def test_load_project_skips_missing_modules_when_enabled():
|
||||
loader = GriffeLoader()
|
||||
@@ -18,4 +18,4 @@ def test_load_project_skips_missing_modules_when_enabled():
|
||||
skip_import_errors=True,
|
||||
)
|
||||
|
||||
assert "sys" in project.modules
|
||||
assert "sys" in project.modules
|
||||
|
||||
@@ -2,9 +2,7 @@ from docforge import GriffeLoader
|
||||
|
||||
|
||||
def test_missing_docstrings(temp_package):
|
||||
(temp_package / "nodoc.py").write_text(
|
||||
'''def f(): pass'''
|
||||
)
|
||||
(temp_package / "nodoc.py").write_text("""def f(): pass""")
|
||||
|
||||
loader = GriffeLoader()
|
||||
project = loader.load_project(["testpkg.nodoc"])
|
||||
|
||||
@@ -2,11 +2,9 @@ from docforge import GriffeLoader
|
||||
|
||||
|
||||
def test_private_members_excluded(temp_package):
|
||||
(temp_package / "priv.py").write_text(
|
||||
'''def _hidden(): pass
|
||||
(temp_package / "priv.py").write_text("""def _hidden(): pass
|
||||
def visible(): pass
|
||||
'''
|
||||
)
|
||||
""")
|
||||
|
||||
loader = GriffeLoader()
|
||||
project = loader.load_project(["testpkg.priv"])
|
||||
|
||||
@@ -2,13 +2,11 @@ from docforge import GriffeLoader
|
||||
|
||||
|
||||
def test_load_single_module(temp_package):
|
||||
(temp_package / "mod.py").write_text(
|
||||
'''"""Module docstring."""\n
|
||||
(temp_package / "mod.py").write_text('''"""Module docstring."""\n
|
||||
def foo():
|
||||
"""Foo docstring."""
|
||||
pass
|
||||
'''
|
||||
)
|
||||
''')
|
||||
|
||||
loader = GriffeLoader()
|
||||
project = loader.load_project(["testpkg.mod"])
|
||||
|
||||
Reference in New Issue
Block a user