Skip to content

DOC: Contributing - escaping backslash. #33243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 2, 2020

Conversation

MarianD
Copy link
Contributor

@MarianD MarianD commented Apr 2, 2020

Non-escaped backslash disappeared in resulting doc.

  • closes #xxxx
  • tests added / passed
  • passes black pandas
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • whatsnew entry

Non-escaped backslash disappeared in resulting doc.
MarianD and others added 2 commits April 2, 2020 22:30
Non-escaped backslash disappeared in resulting doc.
@@ -295,7 +295,7 @@ Below is a brief overview on how to set-up a virtual environment with Powershell
under Windows. For details please refer to the
`official virtualenv user guide <https://virtualenv.pypa.io/en/stable/userguide/#activate-script>`__

Use an ENV_DIR of your choice. We'll use ~\virtualenvs\pandas-dev where
Use an ENV_DIR of your choice. We'll use ~\<span class="x x-first x-last">\</span>virtualenvs\\pandas-dev where
Copy link
Member

Choose a reason for hiding this comment

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

What's the point of the span tag here? We typically don't embed HTML like this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@WillAyd, the putting span tag was not my own action. I simply accepted — I think your — recommendation by clicking a button.

In my cloned Git repository there is a note in this commit:

Co-Authored-By: William Ayd [email protected]

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Use an ENV_DIR of your choice. We'll use ~\<span class="x x-first x-last">\</span>virtualenvs\\pandas-dev where
Use an ENV_DIR of your choice. We'll use ~\\virtualenvs\\pandas-dev where

Hmm that's interesting. Maybe GH is just escaping it on its own.

Can try again, but otherwise might want to fix locally and repush. Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@WillAyd, your explanation is probably right, thanks. I did as you suggested — fixed it locally and repushed.

Non-escaped backslashes disappeared in resulting doc.
@WillAyd WillAyd added the Docs label Apr 2, 2020
@WillAyd WillAyd added this to the 1.1 milestone Apr 2, 2020
@WillAyd WillAyd merged commit 1d4d460 into pandas-dev:master Apr 2, 2020
@WillAyd
Copy link
Member

WillAyd commented Apr 2, 2020

Great thanks @MarianD

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants