Add FastxRecord to the docs#1245
Merged
Merged
Conversation
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:
These appear to be the default rendering for Perhaps we can add some docstrings to the .pyx file to override this rendering and provide some meaningful information for these properties… |
Contributor
Author
|
@jmarshall bump |
Member
|
Thanks for the reminder on this one. (All of @TimD1's documentation PRs are very much on the short-list already BTW.) |
Add FastxRecord to API documentation and improve its docstring with proper Sphinx-style documentation including attributes, parameters, and usage examples.
where Cython will use it to populate these attributes' docstrings. Remove embedsignature=True as it caused these to get bad type information. This unembedding removes the `self` parameter from the documentation of seven existing methods in libcfaidx.pyx, but this arguably improves them. Add/improve the documentation of the other Python-visible FastxRecord methods. Add a __repr__() method for ease of observation.
jmarshall
approved these changes
Jul 14, 2026
Contributor
Author
|
Thanks @jmarshall! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.