Skip to content

Contribution Guide - Building the Documentation single function error #25478

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
MaxVanDeursen opened this issue Feb 28, 2019 · 0 comments · Fixed by #25479
Closed

Contribution Guide - Building the Documentation single function error #25478

MaxVanDeursen opened this issue Feb 28, 2019 · 0 comments · Fixed by #25479
Labels
Milestone

Comments

@MaxVanDeursen
Copy link
Contributor

Code Sample, a copy-pastable example if possible

python make.py --single DataFrame.join
Traceback (most recent call last):
  File "make.py", line 339, in <module>
    sys.exit(main())
  File "make.py", line 334, in main
    args.verbosity, args.warnings_are_errors)
  File "make.py", line 46, in __init__
    single_doc = self._process_single_doc(single_doc)
  File "make.py", line 88, in _process_single_doc
    'pandas.DataFrame.head)').format(single_doc))
ValueError: --single=DataFrame.join not understood. Value should be a valid path to a .rst or .ipynb file, or a valid pandas object (e.g. categorical.rst or pandas.DataFrame.head)

Problem description

Using the code snippet described in the pandas contribution guide (https://pandas-docs.github.io/pandas-docs-travis/development/contributing.html#id48), we get a ValueError. This is fixed by instead using the following command:

python make.py --single pandas.DataFrame.join

I will create a PR updating the documentation.

@MaxVanDeursen MaxVanDeursen changed the title Contribution Guide - Building the Documentation Error Contribution Guide - Building the Documentation single function error Feb 28, 2019
@jreback jreback added this to the 0.25.0 milestone Feb 28, 2019
@jreback jreback added the Docs label Feb 28, 2019
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.

2 participants