Skip to content

gh-93654: Add module docstring to pathlib#94611

Merged
miss-islington merged 4 commits into
python:mainfrom
kj7rrv:pathlib-docstring
Jul 7, 2022
Merged

gh-93654: Add module docstring to pathlib#94611
miss-islington merged 4 commits into
python:mainfrom
kj7rrv:pathlib-docstring

Conversation

@kj7rrv

@kj7rrv kj7rrv commented Jul 6, 2022

Copy link
Copy Markdown
Contributor

Issue: gh-93654

Automerge-Triggered-By: GH:brettcannon

@kj7rrv

kj7rrv commented Jul 6, 2022

Copy link
Copy Markdown
Contributor Author

What is the correct way to mark up the name of a class in ReST?

@brettcannon

Copy link
Copy Markdown
Member

/cc @barneygale

What is the correct way to mark up the name of a class in ReST?

I assume you're referring to your news entry, and in that instance you don't mark up the class name.

@kj7rrv

kj7rrv commented Jul 6, 2022

Copy link
Copy Markdown
Contributor Author

@brettcannon 2acf6de should fix it.

Comment thread Lib/pathlib.py Outdated
kj7rrv and others added 2 commits July 6, 2022 18:26
Co-authored-by: Éric <merwok@netwok.org>
@bedevere-bot

Copy link
Copy Markdown

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

@merwok merwok changed the title gh-93654: Add docstring to pathlib gh-93654: Add module docstring to pathlib Jul 7, 2022
@merwok

merwok commented Jul 7, 2022

Copy link
Copy Markdown
Member

✅ but I would like someone else to approve the text 🙂

@barneygale barneygale left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me, nice work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants