Skip to content

gh-97913 Docs: Add walrus operator to the index#97921

Merged
ezio-melotti merged 3 commits intopython:mainfrom
hugovk:add-walrus-index
Oct 8, 2022
Merged

gh-97913 Docs: Add walrus operator to the index#97921
ezio-melotti merged 3 commits intopython:mainfrom
hugovk:add-walrus-index

Conversation

@hugovk
Copy link
Member

@hugovk hugovk commented Oct 5, 2022 •
edited by bedevere-bot
Loading

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 5, 2022
@hugovk hugovk changed the title Docs: Add walrus operator to the index gh-97913 Docs: Add walrus operator to the index Oct 5, 2022
@hugovk hugovk removed the skip issue label Oct 5, 2022
@Mariatta Mariatta added skip issue needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Oct 5, 2022
@hugovk hugovk mentioned this pull request Oct 5, 2022
Closed
Mariatta
Mariatta reviewed Oct 5, 2022
View reviewed changes
@simon04 simon04 mentioned this pull request Oct 5, 2022
Closed
@hugovk @Mariatta
Add named expression to the index
3e20368 
Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
ezio-melotti
ezio-melotti reviewed Oct 5, 2022
View reviewed changes
Copy link
Member

@ezio-melotti ezio-melotti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this use operator: instead of single, at least on the first entry (and possibly on the others too)?

@hugovk @ezio-melotti
Fix indentation and add missing newline
5eb1267 
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@hugovk
Copy link
Member Author

hugovk commented Oct 6, 2022

Should this use operator: instead of single, at least on the first entry (and possibly on the others too)?

https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#index-generating-markup says of "module, keyword, operator, object, exception, statement, builtin":

These are Python-specific and therefore deprecated.

So maybe not?

@ezio-melotti
Copy link
Member

ezio-melotti commented Oct 6, 2022

We have several of those in our docs already, so there are a few options:

  • keep using them if it's a silent deprecation with no removal plans
  • reimplement them in pyspecific.py, if we want to keep use them (and if it's possible to reimplement them)
  • remove them and stick to the non-deprecated ones

I'll open a separate issue about this.

@ezio-melotti ezio-melotti mentioned this pull request Oct 6, 2022
Closed
@ezio-melotti ezio-melotti merged commit 2963130 into python:main Oct 8, 2022
@miss-islington
Copy link
Contributor

miss-islington commented Oct 8, 2022

Thanks @hugovk for the PR, and @ezio-melotti for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

@bedevere-bot
Copy link

bedevere-bot commented Oct 8, 2022

GH-98087 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Oct 8, 2022
@bedevere-bot
Copy link

bedevere-bot commented Oct 8, 2022

GH-98088 is a backport of this pull request to the 3.10 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 8, 2022
@hugovk @miss-islington
pythongh-97913 Docs: Add walrus operator to the index (pythonGH-97921)
d24a9ed 
* Add walrus operator to the index

* Add named expression to the index

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>

* Fix indentation and add missing newline

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 2963130)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 8, 2022
@hugovk @miss-islington
pythongh-97913 Docs: Add walrus operator to the index (pythonGH-97921)
b67da64 
* Add walrus operator to the index

* Add named expression to the index

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>

* Fix indentation and add missing newline

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 2963130)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
miss-islington added a commit that referenced this pull request Oct 8, 2022
@miss-islington @hugovk
gh-97913 Docs: Add walrus operator to the index (GH-97921)
9828ccb 
* Add walrus operator to the index

* Add named expression to the index

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>

* Fix indentation and add missing newline

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 2963130)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
miss-islington added a commit that referenced this pull request Oct 8, 2022
@miss-islington @hugovk
gh-97913 Docs: Add walrus operator to the index (GH-97921)
a2ce21f 
* Add walrus operator to the index

* Add named expression to the index

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>

* Fix indentation and add missing newline

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 2963130)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@hugovk hugovk deleted the add-walrus-index branch October 8, 2022 14:23
carljm added a commit to carljm/cpython that referenced this pull request Oct 8, 2022
@carljm
Merge branch 'main' into typewatch
d67d6fd 
* main:
  pythongh-68686: Retire eptag ptag scripts (python#98064)
  pythongh-97922: Run the GC only on eval breaker (python#97920)
  GitHub Workflows security hardening (python#96492)
  Add `@ezio-melotti` as codeowner for `.github/`. (python#98079)
  pythongh-97913 Docs: Add walrus operator to the index (python#97921)
  [doc] Fix broken links to C extensions accelerating stdlib modules (python#96914)
  pythongh-97822: Fix http.server documentation reference to test() function (python#98027)
  pythongh-91052: Add PyDict_Unwatch for unwatching a dictionary (python#98055)
  pythonGH-98023: Change default child watcher to PidfdChildWatcher on supported systems (python#98024)
  pythonGH-94182: Run the PidfdChildWatcher on the running loop (python#94184)
carljm added a commit to carljm/cpython that referenced this pull request Oct 9, 2022
@carljm
Merge branch 'main' into urllibnonet
132c32e 
* main: (5519 commits)
  Minor edits to the Descriptor HowTo Guide (pythonGH-24901)
  Fix link to Lifecycle of a Pull Request in CONTRIBUTING (python#98102)
  pythonGH-94597: deprecate `SafeChildWatcher`, `FastChildWatcher` and `MultiLoopChildWatcher` child watchers  (python#98089)
  Auto-cancel old builds when new commit pushed to branch (python#98009)
  pythongh-95011: Migrate syslog module to Argument Clinic (pythonGH-95012)
  pythongh-68686: Retire eptag ptag scripts (python#98064)
  pythongh-97922: Run the GC only on eval breaker (python#97920)
  GitHub Workflows security hardening (python#96492)
  Add `@ezio-melotti` as codeowner for `.github/`. (python#98079)
  pythongh-97913 Docs: Add walrus operator to the index (python#97921)
  [doc] Fix broken links to C extensions accelerating stdlib modules (python#96914)
  pythongh-97822: Fix http.server documentation reference to test() function (python#98027)
  pythongh-91052: Add PyDict_Unwatch for unwatching a dictionary (python#98055)
  pythonGH-98023: Change default child watcher to PidfdChildWatcher on supported systems (python#98024)
  pythonGH-94182: Run the PidfdChildWatcher on the running loop (python#94184)
  pythongh-92886: make test_ast pass with -O (assertions off) (pythonGH-98058)
  pythongh-92886: make test_coroutines pass with -O (assertions off) (pythonGH-98060)
  pythongh-57179: Add note on symlinks for os.walk (python#94799)
  pythongh-94808: Fix regex on exotic platforms (python#98036)
  pythongh-90085: Remove vestigial -t and -c timeit options (python#94941)
  ...
mpage pushed a commit to mpage/cpython that referenced this pull request Oct 11, 2022
@hugovk @Mariatta
@ezio-melotti @mpage
pythongh-97913 Docs: Add walrus operator to the index (python#97921)
637bf6a 
* Add walrus operator to the index

* Add named expression to the index

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>

* Fix indentation and add missing newline

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
@miss-islington @hugovk @pablogsal
gh-97913 Docs: Add walrus operator to the index (GH-97921)
9b6afbe 
* Add walrus operator to the index

* Add named expression to the index

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>

* Fix indentation and add missing newline

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 2963130)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Mariatta Mariatta Mariatta approved these changes

@ezio-melotti ezio-melotti ezio-melotti approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@hugovk @ezio-melotti @miss-islington @bedevere-bot @Mariatta