Skip to content

DOC: Add header to test_writing.rst #39468

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
gustavocmaciel opened this issue Jan 29, 2021 · 4 comments
Closed

DOC: Add header to test_writing.rst #39468

gustavocmaciel opened this issue Jan 29, 2021 · 4 comments
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member

Comments

@gustavocmaciel
Copy link
Contributor

Location of the documentation

https://github.com/pandas-dev/pandas/blob/master/doc/source/development/test_writing.rst

Documentation problem

The test_writitng.rst file doesn't have the standard header.

Suggested fix for documentation

This can be fixed by adding {{ header }} at the beginning of the file.

@gustavocmaciel gustavocmaciel added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jan 29, 2021
@jorisvandenbossche
Copy link
Member

Is it a problem that this header is not present in this file?

@gustavocmaciel
Copy link
Contributor Author

I wouldn't call this a problem, per se, but since all the .rst files contain this header, it looks like there's a standard, am I right?

@jorisvandenbossche
Copy link
Member

Yes, but it's only needed for pages that actually have ipython code blocks that get executed (and this page doesn't have that) + there is also an issue about removing this header -> #28038

@gustavocmaciel
Copy link
Contributor Author

Yeah there's a full discussion about it. Thanks for clarifying!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member
Projects
None yet
Development

No branches or pull requests

2 participants