Skip to content

Conversation

@nh13
Copy link
Contributor

@nh13 nh13 commented Nov 25, 2023

No description provided.

@jmarshall
Copy link
Member

When we add a previously omitted class to api.rst, we suddenly find out whether its docstrings render well as reStructuredText or provide useful information at all. In this case, some of it's not great:

name
    unicode
        Type: name

These appear to be the default rendering for cdef public str from the .pxd file. (These are the only public str items in pysam.) “Unicode” is irrelevant as we're Python 3 only, and “Type” is just wrong.

Perhaps we can add some docstrings to the .pyx file to override this rendering and provide some meaningful information for these properties…

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