Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor the the ParsedTypeDocstring #874

Draft
wants to merge 24 commits into
base: master
Choose a base branch
from
Draft

Refactor the the ParsedTypeDocstring #874

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
ec6c907
Make the linker always output link tags only. No <code> tags. The <co…
tristanlatr Feb 2, 2025
f06cd12
Fix #723 and #581
tristanlatr Feb 2, 2025
788957d
Fix the linenumber issue in the new references
tristanlatr Feb 2, 2025
aefe3c7
Help mypy
tristanlatr Feb 2, 2025
c6ffcef
trying this...
tristanlatr Feb 2, 2025
a8d9af8
Revert "trying this..."
tristanlatr Feb 2, 2025
30bdf2b
Turns out this refactors fixes an obscure bug that would trigger unex…
tristanlatr Feb 2, 2025
ec37bff
Try to fix mypy
tristanlatr Feb 2, 2025
36f6eba
Fix tests of docs
tristanlatr Feb 2, 2025
bd9d457
Showcase the literak choices of google/numpy in the demo
tristanlatr Feb 6, 2025
ed1e6d9
Re-enable spelling extension
tristanlatr Feb 13, 2025
5f5542a
Fix the numpy-style type in the demo
tristanlatr Feb 14, 2025
042f9dc
Actually fix a couple of issues:
tristanlatr Feb 14, 2025
c68853b
Merge branch '873-implement-parsedtypedocstring.to_node' of github.co…
tristanlatr Feb 14, 2025
6703a1f
This changes simplify the parsed type docstring and makes the logic l…
tristanlatr Feb 14, 2025
a554adc
Properly add regression test for the duplicated type attribute bug
tristanlatr Feb 14, 2025
742850a
fix pyflakes
tristanlatr Feb 14, 2025
2681285
get_lineno refactor
tristanlatr Feb 17, 2025
dace95f
Revert "get_lineno refactor"
tristanlatr Feb 17, 2025
40a8623
Simplification now that the nested warnings are not useful
tristanlatr Feb 17, 2025
32cbcfa
add a comment to get_lineno
tristanlatr Feb 19, 2025
8359c43
Merge branch 'master' into 873-implement-parsedtypedocstring.to_node
tristanlatr Feb 19, 2025
cba36ab
Merge branch 'master' into 873-implement-parsedtypedocstring.to_node
tristanlatr Feb 19, 2025
7eb22b7
Remove unused import
tristanlatr Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/google_demo/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ def function_with_types_in_docstring(param1, param2):

Args:
param1 (int): The first parameter.
param2 (str): The second parameter.
param2 (str, one of {"html", "json", "xml"}, optional): The second parameter.

Returns:
bool: The return value. True for success, False otherwise.
Expand Down
2 changes: 1 addition & 1 deletion docs/numpy_demo/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ def function_with_types_in_docstring(param1, param2):
----------
param1 : int
The first parameter.
param2 : str
param2 : str, one of {"html", "json", "xml"}, optional)
The second parameter.

Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"sphinx_rtd_theme",
"sphinx.ext.intersphinx",
"pydoctor.sphinx_ext.build_apidocs",
"sphinxcontrib.spelling",
# "sphinxcontrib.spelling",
"sphinxarg.ext",
]

Expand Down
Loading