FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

bpo-35181: Correct importlib documentation for some module attributes by geryogam · Pull Request #15190 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

bpo-35181: Correct importlib documentation for some module attributes - #15190

Merged
miss-islington merged 7 commits into
python:masterfrom
geryogam:patch-7
Oct 21, 2020
ConversationCommits (7)ChecksFiles changed
Merged

bpo-35181: Correct importlib documentation for some module attributes#15190
miss-islington merged 7 commits into
python:masterfrom
geryogam:patch-7

Conversation

geryogam commented Aug 9, 2019 •
edited by miss-islington
Loading

Copy link
Copy Markdown
Contributor

@ericsnowcurrently This PR will change the following:

In the library documentation importlib.rst:

  • module.__package__ can be module.__name__ for packages;
  • spec.parent can be spec.__name__ for packages;
  • spec.loader is not None for namespaces packages.

In the language documentation import.rst:

  • spec.loader is not None for namespace packages.

https://bugs.python.org/issue35181

Automerge-Triggered-By: GH:warsaw

bedevere-bot added docs Documentation in the Doc dir awaiting review labels Aug 9, 2019
geryogam marked this pull request as ready for review August 9, 2019 10:13
geryogam mentioned this pull request Aug 9, 2019
Merged
geryogam changed the title bpo-35181: Correct some module attribute descriptions in the documentation bpo-35181: Correct the documentation on some module attributes Aug 9, 2019
ericsnowcurrently self-requested a review August 9, 2019 15:04
aeros previously requested changes Aug 10, 2019
View reviewed changes

aeros left a comment •
edited
Loading

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks for the PR. The title should be changed to something a bit more descriptive so that the core devs know which top-level module it involves without having to look at the PR itself. I would advise something along the lines of "Update importlib documentation for module attributes".

I have a few suggestions:

Comment thread Doc/library/importlib.rst
Comment thread Doc/library/importlib.rst
Comment thread Doc/library/importlib.rst Outdated
Comment thread Doc/library/importlib.rst Outdated
geryogam changed the title bpo-35181: Correct the documentation on some module attributes bpo-35181: Correct importlib library and import language documentation for some module attributes Aug 10, 2019
geryogam changed the title bpo-35181: Correct importlib library and import language documentation for some module attributes bpo-35181: Correct importlib documentation for some module attributes Aug 10, 2019

geryogam commented Aug 10, 2019 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

@aeros167 Thank you for the suggestions. I have updated the PR title. As for your other suggestions, I am fine with them but I would like to have @ericsnowcurrently's opinion before applying them.

aeros commented Aug 21, 2019

Copy link
Copy Markdown
Contributor

Since this PR is involving documentation corrections and does not add any new sections, I'll add a skip news label. If you'd like to include one, I can remove it though.

geryogam commented Sep 11, 2019

Copy link
Copy Markdown
Contributor Author

@ericsnowcurrently What do you think of @aeros167 suggested changes?

warsaw and others added 2 commits October 21, 2020 11:39
Use a term link instead of a class link
583eb62 
Co-authored-by: Kyle Stanley <aeros167@gmail.com>
Add a term link for "Finders"
3c10dfb 
Co-authored-by: Kyle Stanley <aeros167@gmail.com>
warsaw requested a review from aeros October 21, 2020 18:41
warsaw dismissed aeros’s stale review October 21, 2020 18:56

See comments in place above. Thank you for the requested changes, but I think this PR is good now. Using Dismiss review was the only way I could see to avoid this blocking the PR.

miss-islington commented Oct 21, 2020

Copy link
Copy Markdown
Contributor

@maggyero: Status check is done, and it's a failure ❌ .

warsaw commented Oct 21, 2020

Copy link
Copy Markdown
Member

I'll check out this branch locally and repair the build failures.

miss-islington commented Oct 21, 2020

Copy link
Copy Markdown
Contributor

@maggyero: Status check is done, and it's a success ✅ .

miss-islington commented Oct 21, 2020

Copy link
Copy Markdown
Contributor

Sorry, I can't merge this PR. Reason: 2 of 4 required status checks are expected..

miss-islington commented Oct 21, 2020

Copy link
Copy Markdown
Contributor

@maggyero: Status check is done, and it's a success ✅ .

1 similar comment

miss-islington commented Oct 21, 2020

Copy link
Copy Markdown
Contributor

@maggyero: Status check is done, and it's a success ✅ .

miss-islington commented Oct 21, 2020

Copy link
Copy Markdown
Contributor

Sorry, I can't merge this PR. Reason: 2 of 4 required status checks are expected..

1 similar comment

miss-islington commented Oct 21, 2020

Copy link
Copy Markdown
Contributor

Sorry, I can't merge this PR. Reason: 2 of 4 required status checks are expected..

miss-islington commented Oct 21, 2020

Copy link
Copy Markdown
Contributor

@maggyero: Status check is done, and it's a failure ❌ .

miss-islington commented Oct 21, 2020

Copy link
Copy Markdown
Contributor

@maggyero: Status check is done, and it's a success ✅ .

miss-islington merged commit 27f1bd8 into python:master Oct 21, 2020

miss-islington commented Oct 21, 2020

Copy link
Copy Markdown
Contributor

Thanks @maggyero for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 21, 2020
bpo-35181: Correct importlib documentation for some module attributes (…
4eb8e8a 
…pythonGH-15190)

@ericsnowcurrently This PR will change the following:

In the library documentation importlib.rst:

- `module.__package__` can be `module.__name__` for packages;
- `spec.parent` can be `spec.__name__` for packages;
- `spec.loader` is not `None` for namespaces packages.

In the language documentation import.rst:

- `spec.loader` is not `None` for namespace packages.

Automerge-Triggered-By: GH:warsaw
(cherry picked from commit 27f1bd8)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>

bedevere-bot commented Oct 21, 2020

Copy link
Copy Markdown

GH-22872 is a backport of this pull request to the 3.9 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 21, 2020
bpo-35181: Correct importlib documentation for some module attributes (…
5b0acea 
…pythonGH-15190)

@ericsnowcurrently This PR will change the following:

In the library documentation importlib.rst:

- `module.__package__` can be `module.__name__` for packages;
- `spec.parent` can be `spec.__name__` for packages;
- `spec.loader` is not `None` for namespaces packages.

In the language documentation import.rst:

- `spec.loader` is not `None` for namespace packages.

Automerge-Triggered-By: GH:warsaw
(cherry picked from commit 27f1bd8)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>

bedevere-bot commented Oct 21, 2020

Copy link
Copy Markdown

GH-22873 is a backport of this pull request to the 3.8 branch.

miss-islington added a commit that referenced this pull request Oct 21, 2020
bpo-35181: Correct importlib documentation for some module attributes (…
916ac95 
…GH-15190)

@ericsnowcurrently This PR will change the following:

In the library documentation importlib.rst:

- `module.__package__` can be `module.__name__` for packages;
- `spec.parent` can be `spec.__name__` for packages;
- `spec.loader` is not `None` for namespaces packages.

In the language documentation import.rst:

- `spec.loader` is not `None` for namespace packages.

Automerge-Triggered-By: GH:warsaw
(cherry picked from commit 27f1bd8)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
miss-islington added a commit that referenced this pull request Oct 21, 2020
bpo-35181: Correct importlib documentation for some module attributes (…
6e842bc 
…GH-15190)

@ericsnowcurrently This PR will change the following:

In the library documentation importlib.rst:

- `module.__package__` can be `module.__name__` for packages;
- `spec.parent` can be `spec.__name__` for packages;
- `spec.loader` is not `None` for namespaces packages.

In the language documentation import.rst:

- `spec.loader` is not `None` for namespace packages.

Automerge-Triggered-By: GH:warsaw
(cherry picked from commit 27f1bd8)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 13, 2021
bpo-35181: Correct importlib documentation for some module attributes (…
fd5d2b1 
…pythonGH-15190)

@ericsnowcurrently This PR will change the following:

In the library documentation importlib.rst:

- `module.__package__` can be `module.__name__` for packages;
- `spec.parent` can be `spec.__name__` for packages;
- `spec.loader` is not `None` for namespaces packages.

In the language documentation import.rst:

- `spec.loader` is not `None` for namespace packages.

Automerge-Triggered-By: GH:warsaw
warsaw mentioned this pull request Apr 27, 2022
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

warsaw warsaw approved these changes
ericsnowcurrently Awaiting requested review from ericsnowcurrently
aeros Awaiting requested review from aeros

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

Back | FazBrowse Home | New Git URL