Repository navigation
Conversation
Documentation build overview
|
|
Thanks for the feedback. I find the rythme of some parts of the text a bit to LLM-isque but if native speakers think it's fine, I'm going to keep it as is. |
| configuration used. Run the benchmarks with :pypi:`pyperf` rather than | ||
| with plain :mod:`timeit`. Optimizing a cold path, or a rare case at the |
There was a problem hiding this comment.
Is there room for nuance here?
Are there any cases where timeit is suitable and a full, time-consuming, pyperf run is not needed?
Likewise, can -X importtime be enough for improving import time?
There was a problem hiding this comment.
pyperf timeit is enough and -X importtime is enough. I wanted to write a benchmarking guide as well. I can write it first and link it afterwards.
There was a problem hiding this comment.
What I mean: please don't just use timeit because it only reports the fastest paths in general. It's a good indication of whether something CAN be faster, but it's preferrable to know how flaky it is for instance.
| Trivial documentation changes, such as typo fixes, and pull requests that | ||
| only increase test coverage usually need neither an issue nor a NEWS | ||
| entry. When fixing typos, fix all of them in the page or in the |
There was a problem hiding this comment.
I think this is duplicating existing instructions on this page?
There was a problem hiding this comment.
I wasn't able to find the sentence about "make more than one fix please for the entire .rst doc" and sync it with the docstrings as well. I'll ask an agent to check that.
| Python and C code, in a single pull request. If the bot asks for an issue | ||
| or a NEWS entry, a triager will add the :gh-label:`skip issue` and | ||
| :gh-label:`skip news` labels instead. |
There was a problem hiding this comment.
Can you pinpoint the location? I think we say something similar though but I wanted to highlight what I usually see. Like:
- someone opens a PR for fixing a typo
- it touches a non-rst file
- bot doesn't apply SKIP NEWS
- user pings everyone (after the fact)
I can add a ref to the "When is a NEWS needed" though.
First draft of issue/PR choregraphy while staying a bit vague. I used Opus 5.5 for the text and reading the existing parts of the devguide and to polish the tone in a more... diplomatic way I would have said.
Once reviews start, I'm going to make the changes manually (likely).