Skip to content

Fix docstring for md.update()#1203

Merged
asvetlov merged 3 commits intoaio-libs:masterfrom
asvetlov:docsting
Jun 25, 2025
Merged

Fix docstring for md.update()#1203
asvetlov merged 3 commits intoaio-libs:masterfrom
asvetlov:docsting

Conversation

@asvetlov
Copy link
Member

@asvetlov asvetlov commented Jun 25, 2025

We use markup in docs, not in docstrings for C and Python code.

@asvetlov asvetlov marked this pull request as ready for review June 25, 2025 13:28
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Jun 25, 2025
@asvetlov asvetlov requested a review from webknjaz as a code owner June 25, 2025 13:28
@webknjaz
Copy link
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-hq
Copy link

codspeed-hq bot commented Jun 25, 2025

CodSpeed Performance Report

Merging #1203 will improve performances by 11.21%

Comparing asvetlov:docsting (c3acd3b) with master (2119f97)

Summary

⚡ 1 improvements
✅ 243 untouched benchmarks

Benchmarks breakdown

Benchmark BASE HEAD Change
test_multidict_getall_str_hit[cs-py] 1.8 ms 1.6 ms +11.21%

@asvetlov
Copy link
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.

@asvetlov asvetlov merged commit 8cfe02b into aio-libs:master Jun 25, 2025
64 checks passed
@asvetlov asvetlov deleted the docsting branch June 25, 2025 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bot:chronographer:provided There is a change note present in this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants