Some improvements to the core module docs #3252
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
refspecific=True
from xref nodes so that Sphinx can resolve references to data attributes such as_typing.ReadableBuffer
. (See Fig. 1)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.make check-stubs
command which validate the generated stubs with mypy.Fig. 1:
![Screen Shot 2020-08-04 at 18 08 26](https://user-images.githubusercontent.com/5351911/89550258-601b5080-d844-11ea-97f1-6bb776145e60.png)
FIg. 2:
![sc](https://user-images.githubusercontent.com/5351911/89550210-4da11700-d844-11ea-9bcf-952ff9db767f.png)