Skip to content

Docs fixes#327

Merged
Christian-B merged 24 commits into
masterfrom
docs_fixes
Jul 9, 2025
Merged

Docs fixes#327
Christian-B merged 24 commits into
masterfrom
docs_fixes

Conversation

@Christian-B

@Christian-B Christian-B commented Jul 7, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

includes
#326
#325
#324
#323

Changes to doc checker.

  • ignore most checks in unittests
    • Only check params are correct and not typed
  • "Never" is not a return
  • cls and self are not considered params.
    • already merged in by sub pr

Christian-B added 21 commits July 3, 2025 12:18
@Christian-B
remove returns from property methods
d4b71b8
@Christian-B
add returns in docs
ef95731
@Christian-B
make methods protected
247d3a4
@Christian-B
add returns to docs
f5dc9ff
@Christian-B
fix test for returns
6269dd9
@Christian-B
in optionxform rename param to option
5c13a54
@Christian-B
rename fget to method
706fa66
@Christian-B
skip many checks for unittests
83a0ca7
@Christian-B
revert changes
43710a7
@Christian-B
Revert "in optionxform rename param to option"
19ac706 
This reverts commit 5c13a54.
@Christian-B
merged in master
98ce8d6
@Christian-B
merged in master
bbaf29f
@Christian-B
Merge branch 'master' into property_docs
9a51d57
@Christian-B
remove self and cls from param names
b848470
@Christian-B
add param(s) to docs
d0d6511
@Christian-B
check docs have all or no params
4d51c8f
@Christian-B
merged in remote/property_docs
dc996e2
@Christian-B
Merge branch 'init_docs' into docs_fixes
bc64fe4
@Christian-B
Merge remote-tracking branch 'origin/param_docs' into docs_fixes
c3d842b 
# Conflicts:
#	unittests/test_doc_checker.py
@Christian-B
remove all exclusions
f816e44
@Christian-B
Merge remote-tracking branch 'origin/returns_docs' into docs_fixes
678b2cc 
# Conflicts:
#	unittests/test_doc_checker.py
@Christian-B Christian-B requested a review from rowleya July 7, 2025 09:06
@Christian-B Christian-B mentioned this pull request Jul 7, 2025
Merged
@Christian-B Christian-B merged commit aa9ad99 into master Jul 9, 2025
9 checks passed
@Christian-B Christian-B deleted the docs_fixes branch July 9, 2025 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rowleya rowleya rowleya approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Christian-B @rowleya @spinnakermanchesteruser