Fix docstring for md.update()#1203
Merged
asvetlov merged 3 commits intoaio-libs:masterfrom Jun 25, 2025
Merged
Conversation
Member
|
I'm not sure about this. I'd love to generate API docs from docstrings. But even if not, there's still use for these. Docstrings can show up in different development UIs in editors. I think they render this markup too. |
CodSpeed Performance ReportMerging #1203 will improve performances by 11.21%Comparing Summary
Benchmarks breakdown
|
Member
Author
|
Let's either generate documentation from doctrings and start using markups, or drop the markup if we don't use it anywhere except the single place. Moreover, the existing dosctring is not correct, there is no other argument in the method's signature. I propose the less invasive change; if somebody wants to work on the library documentation -- I'd love to review the PR. |
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
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.
We use markup in docs, not in docstrings for C and Python code.