lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-05-04 17:10:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean up docstrings in python interfaces to be strictly typed/formatted

Browse Source 
* Also added a script that can run as part of CI to verify that the docstring
  matches, by generating a regex from the docstring documented parameter types
  and return type and making sure we find a match within the C headers. This
  ensures all parameters are documented with the right types, no extra
  parameters are documented, and the return type is correct.
* The script also checks proper scoping so that if qrenderdoc docstrings
  mention a renderdoc type, they need to scope it properly.
This commit is contained in:
baldurk
2020-12-07 12:42:35 +00:00
parent e5f4ca7bb8
commit 6b8ce92d88
33 changed files with 1178 additions and 592 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/ci.yml
+1
View File
@@ -151,6 +151,7 @@ jobs:
run: |
cd docs
make html SPHINXOPTS=-W
python3 ./docs/verify-docstrings.py
linux:
name: Linux
needs: [commit-msg, clang-format]