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.

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

Some improvements to the core module docs #3252

Merged
merged 3 commits into from Aug 7, 2020
Merged

Conversation

ciscorn
Copy link

@ciscorn ciscorn commented Aug 6, 2020

  • [Sphinx] Add a Sphinx transform to conf.py to convert the first paragraphs into the module titles. (See FIg. 1 & 2)
    • The titles will look similar to those of v5.3.x docs.
    • It also removes refspecific=True from xref nodes so that Sphinx can resolve references to data attributes such as _typing.ReadableBuffer. (See Fig. 1)
  • [stubs] Make shared-bindings/_typing/__init__.pyi for the types related to the C-level protocols. We shouldn't use _typeshed as it is typeshed's internal utility.
  • [stubs] Add make check-stubs command which validate the generated stubs with mypy.
  • [stubs] Fix some type hints.

Fig. 1:
Screen Shot 2020-08-04 at 18 08 26

FIg. 2:
sc

Copy link
Member

@jepler jepler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not review all the docstring changes

@jepler
Copy link
Member

jepler commented Aug 7, 2020

Should we add "make check-stubs' to our CI workflow?

@jepler jepler merged commit 354edd9 into adafruit:main Aug 7, 2020
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.

None yet

2 participants