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.

Sign up for GitHub

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
Merged

DOC: Contributing - escaping backslash. #33243

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
46cfeae
DOC: Contributing - escaping backslash.
MarianD Apr 2, 2020
a5d762d
DOC: Contributing - escaping backslashes.
MarianD Apr 2, 2020
1f2cfa4
DOC: Workaround of non-displayed backslashes.
MarianD Apr 2, 2020
eb245ac
DOC: Contributing - escaping both backslashes.
MarianD Apr 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/source/development/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 william.ayd@icloud.com

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.

'~' is the folder pointed to by either $env:USERPROFILE (Powershell) or
%USERPROFILE% (cmd.exe) environment variable. Any parent directories
should already exist.
Expand Down