Skip to content

Conversation

9and3
Copy link

@9and3 9and3 commented Sep 30, 2025

Propose a basic first mini PyTest framework to test the sanity of the documentation (scraped from #AICW-17). For now the only proposed test checks if Cadwork symbols used in the Python blocks from examples/ section have up-to-date API signatures, in the following way:

  1. detect the symbols in the py code blocks
  2. compare it with the stubs signatures
  3. raise exception if signature is different and propose 2 possible matches from stubs

E.g. in current state this file, containing isWall in the last py code block will be raised as an error and fail the action (left the typo just for showcase).

image

PS: I agree that the best would be to run the examples in the python code, I do not see how rn, maybe in future..

@9and3 9and3 requested a review from jspaquet as a code owner September 30, 2025 12:32
@CLAassistant
Copy link

CLAassistant commented Sep 30, 2025

CLA assistant check
All committers have signed the CLA.

@9and3 9and3 changed the title [API-535] implemented docs check with python analyser [API-535] test Docs py code blocks for correct API signatures Sep 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants