gh-149187: Doc: Add frozendict to functions.rst#149185
gh-149187: Doc: Add frozendict to functions.rst#149185oyvindronningstad wants to merge 1 commit intopython:mainfrom
Conversation
|
All commit authors signed the Contributor License Agreement. |
Documentation build overview
74 files changed ·
|
oyvindronningstad
changed the title
| | | :func:`dir` | | :func:`isinstance` | | | | | | ||
| | | :func:`divmod` | | :func:`issubclass` | | | | **_** | | ||
| | | | | :func:`iter` | | | | :func:`__import__` | | ||
| | | :func:`bin` | | |func-frozendict|_ | | :func:`min` | | :func:`sentinel` | |
There was a problem hiding this comment.
That's unfortunate that we have to make so many code changes for a single line :(
But, AFAIK there's no other way, see 29a92ab as an example.
There was a problem hiding this comment.
It's possible to forego the empty space before the "G:", which will give a 2-line change instead. Your call.
There was a problem hiding this comment.
Would using a list-table help for future edits?
https://docutils.sourceforge.io/docs/ref/rst/directives.html#list-table
oyvindronningstad
force-pushed
the
doc-frozendict-functions
branch
from
f0b8048 to
2bbe0c7
Compare
|
@sobolevn Thanks for the review! Are there other reviewers I should add? |
Please don't ping people at random. CODEOWNERS/experts are generally requested automatically. |
| frozendict(iterable, /, **kwargs) | ||
| :noindex: | ||
|
|
||
| Create a new frozen dictionary. The :class:`frozendict` object is a builtin class. |
There was a problem hiding this comment.
@nedbat, is the linklint update ready so that we can fix the rendering here?
There was a problem hiding this comment.
linklint==1.0.0 will do it correctly. I'm not sure at the moment how the requirements are handled. It looks like it's still with a manually updated pylock.toml file. That file still uses linklint=0.4.1.
There was a problem hiding this comment.
It looks like it's still with a manually updated pylock.toml file.
Do you plan to open a PR for that, otherwise I think we can bundle it in here?
There was a problem hiding this comment.
I wasn't planning to because I don't know the intent for the future. Hugo seemed in charge of it.
There was a problem hiding this comment.
Go for it! Either here or a new PR.
There was a problem hiding this comment.
I rebased on main after 149467, tell me if I need to do more.
oyvindronningstad
force-pushed
the
doc-frozendict-functions
branch
from
2bbe0c7 to
c50a587
Compare
I'm new here, but it might seem like that automation for this doesn't work for functions.rst. No reviewers were added for a number of days. Just FYI |
| frozendict(iterable, /, **kwargs) | ||
| :noindex: | ||
|
|
||
| Create a new frozen dictionary. The :class:`frozendict` object is a builtin class. |
There was a problem hiding this comment.
| Create a new frozen dictionary. The :class:`frozendict` object is a builtin class. | |
| Create a new frozen dictionary. The :class:`frozendict` object is a built-in class. |
That's because all reviewers have already been added. |
I meant before that. The PR had been open for 5 days when you were added. But again, I don't know anything about your codeowners system. |
Add frozendict to the Built-in Functions table, and add a short entry on the page, derived from the dict and frozenset entries. Also, mention frozendict in the dict entry. Signed-off-by: Øyvind Rønningstad <oyvind.ronningstad@nordicsemi.no>
oyvindronningstad
force-pushed
the
doc-frozendict-functions
branch
from
c50a587 to
786e218
Compare
5 participants
Add frozendict to the Built-in Functions table, and add a short entry on the page, derived from the dict and frozenset entries.
Also, mention frozendict in the dict entry.