Skip to content

Docs: shutil: Hide module name from local (anchor) links#6695

Merged
csabella merged 3 commits into
python:masterfrom
aureliojargas:patch-1
May 11, 2019
Merged

Docs: shutil: Hide module name from local (anchor) links#6695
csabella merged 3 commits into
python:masterfrom
aureliojargas:patch-1

Conversation

@aureliojargas

Copy link
Copy Markdown
Contributor

Inside all the methods descriptions, local links to other shutil methods do not show the module name.

For example, it's:

  • copy2() uses copystat() to copy the file metadata.

not:

  • shutil.copy2() uses shutil.copystat() to copy the file metadata.

This commit fixes the very few outliers that were not following that pattern.

Inside all the methods descriptions, local links to other methods do not show the module name.

For example, it's: 
    copy2() uses copystat() to copy the file metadata.
not:
    shutil.copy2() uses shutil.copystat() to copy the file metadata.

This commit fixes the very few outliers that were not following that pattern.
@the-knights-who-say-ni

Copy link
Copy Markdown

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately our records indicate you have not signed the CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

When your account is ready, please add a comment in this pull request
and a Python core developer will remove the CLA not signed label
to make the bot check again.

Thanks again to your contribution and we look forward to looking at it!

@aureliojargas aureliojargas changed the title Hide module name from local (anchor) links Docs: shutil: Hide module name from local (anchor) links May 2, 2018
@aureliojargas

Copy link
Copy Markdown
Contributor Author

I've signed the CLA.

No issue number since this is a very simple documentation fix.

No news entry is necessary.

@BoboTiG

BoboTiG commented Mar 5, 2019

Copy link
Copy Markdown
Contributor

Thanks @aureliojargas! Do you mind updating you branch to resolve the conflict?

@aureliojargas

Copy link
Copy Markdown
Contributor Author

Done. Tests are green again.

@miss-islington

Copy link
Copy Markdown
Contributor

Thanks @aureliojargas for the PR, and @csabella for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7.
🐍🍒⛏🤖

@miss-islington

Copy link
Copy Markdown
Contributor

Sorry, @aureliojargas and @csabella, I could not cleanly backport this to 3.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker f6e17ddffd3ba52a08e977bd9c6c0d6f2fffa905 3.7

@csabella

Copy link
Copy Markdown
Contributor

@aureliojargas Thank you for the suggestion and the pull request. Your change has now been merged. 🎉 🎉

@aureliojargas aureliojargas deleted the patch-1 branch May 11, 2019 04:13
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.

7 participants