Commit Graph

11 Commits

Author SHA1 Message Date
baldurk 1730e6b5af For callable docstrings allow either std::function or Callback typedef 2026-03-13 13:07:44 +00:00
baldurk 109e524d5c Improve cross-module references in docstrings 2026-03-13 13:07:44 +00:00
baldurk a1473c5f84 Improve docstring checking when a class can't be instantiated
* Also print warnings for the classes that aren't being checked
2026-02-09 18:05:35 +00:00
baldurk 5957a2710b Enforce that all docstrings of members have a :type: 2025-09-09 18:57:35 +01:00
baldurk b4615dbd18 Add a delayed callback helper for python 2025-09-09 18:57:34 +01:00
baldurk 1c7a4c24dd Unwrap staticmethod if necessary when checking python docstrings
* Happens on github CI for some reason.
2025-02-11 00:21:39 +00:00
baldurk 91c935ffde Fix verify-docstrings to handle rdcfixedarray tuples
* Removes a couple of exceptions from functions it can't verify.
2024-11-18 11:31:12 +00:00
baldurk 16b82d1689 Handle rdcstrpair or rdcstrpairs in function return types for docstrings 2021-05-17 15:05:13 +01:00
baldurk e7e2b73170 Search extracted namespace for class, not all headers 2020-12-16 20:39:58 +00:00
baldurk 659fdaa235 Check that all complex struct members that have :type: in docstrings
* Ideally we'd document every member unconditionally for best autocompletion,
  but that's a lot of modification so for now we stick to just making sure that
  any members that are struct types (or lists/tuples) have the :type:
  declaration so that we can autocomplete inside them.
2020-12-09 15:18:27 +00:00
baldurk 6b8ce92d88 Clean up docstrings in python interfaces to be strictly typed/formatted
* 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.
2020-12-07 17:44:51 +00:00