add docstrings to MyMutableMapping to fix github.io rendering issue #2360
Comments
github-merge-queue bot
pushed a commit
to microsoft/typespec
that referenced
this issue
Jan 22, 2025
…n parent (#5707) fixes Azure/autorest.python#2360 --------- Co-authored-by: iscai-msft <[email protected]>
github-merge-queue bot
pushed a commit
to microsoft/typespec
that referenced
this issue
Jan 23, 2025
…n parent (#5707) fixes Azure/autorest.python#2360 --------- Co-authored-by: iscai-msft <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Right now we're getting the docstrings from collections.abc: https://github.com/python/cpython/blob/2e7577b622616ef5ff2d1460fb5bebf845f0edf3/Lib/_collections_abc.py#L919
The issue is that collections.abc use single quotes in their docstrings and for some reason this completely breaks sphinx and puts the docstring into type hint field like:
@iscai-msft tested this and found that if we override the docstrings in MyMutableMapping and use double-quotes we can fix this in the docs.
The text was updated successfully, but these errors were encountered: