Skip to content

DOC: Clarify development environment creation for documentation changes #38193

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

Closed
ooojpeg opened this issue Nov 30, 2020 · 2 comments · Fixed by #38194
Closed

DOC: Clarify development environment creation for documentation changes #38193

ooojpeg opened this issue Nov 30, 2020 · 2 comments · Fixed by #38194
Labels
Milestone

Comments

@ooojpeg
Copy link
Contributor

ooojpeg commented Nov 30, 2020

Location of the documentation

https://pandas.pydata.org/docs/dev/development/contributing.html#creating-a-development-environment

Documentation problem

The documentation for creating a development environment is not really clear regarding the benefits/limitations of creating a development environment when changing documentation.

Suggested fix for documentation

To test out code changes, you’ll need to build pandas from source, which requires a C/C++ compiler and Python environment. If you’re making documentation changes, you can skip to Contributing to the documentation but if you skip creating the development environment you won’t be able to build the documentation locally before pushing your changes.

@ooojpeg ooojpeg added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Nov 30, 2020
@rhshadrach
Copy link
Member

So from

..., you can skip to Contributing to the documentation but you won’t be able...

to

..., you can skip to Contributing to the documentation but if you skip creating the development environment...

It seems clear to me that "but" is referring to "you can skip" in the current version.

@ooojpeg
Copy link
Contributor Author

ooojpeg commented Nov 30, 2020

@rhshadrach I'm not 100% tbh. It confused me for a moment when I read for the first time so thought I'd mention and see if anyone else feels the same.

@jreback jreback added this to the 1.2 milestone Dec 2, 2020
@jreback jreback removed the Needs Triage Issue that has not been reviewed by a pandas team member label Dec 2, 2020
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 a pull request may close this issue.

3 participants