Skip to content

DOC: add links to pre-commit in contributing #43441

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 5 commits into from
Sep 8, 2021

Conversation

feefladder
Copy link
Contributor

  • Ensure all linting tests pass, see here for how to run them
  • whatsnew entry
    The contributing page has comments on style, but does not link to setting up pre-commits yourself. It would be nice to be guided there

Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

Full stop is missing. Can you also post a screenshot to show that this renders correctly?

@feefladder
Copy link
Contributor Author

Now I remember, the main why this is necessary, is that this

Ensure all linting tests pass, see here for how to run them

links to this page, without any further link to how to set up pre-commits.
here you go:
docs
The period is fixed also.
The build process takes very long on my machine (multiple minutes). Is there a way to make it go faster?
Also, I got the following errors while building, unrelated to what I did:

``` WARNING: >>>------------------------------------------------------------------------- Exception in /mnt/data/Git/pd_backup/doc/source/whatsnew/v0.9.1.rst at block ending on line 81 Specify :okexcept: as an option in the ipython:: block to suppress this message --------------------------------------------------------------------------- NameError Traceback (most recent call last) in ----> 1 df = DataFrame(np.random.randn(5, 3), columns = ['A','B','C'])

NameError: name 'DataFrame' is not defined

<<<-------------------------------------------------------------------------
/mnt/data/Git/pd_backup/doc/source/whatsnew/v1.3.0.rst:1250: WARNING: Cannot find contributors for range 'v1.2.5..v1.3.0': Cmd('git') failed due to: exit code(128)
cmdline: git log --grep=Co-authored --pretty=%b v1.2.5..v1.3.0
stderr: 'fatal: ambiguous argument 'v1.2.5..v1.3.0': unknown revision or path not in the working tree.
Use '--' to separate paths from revisions, like this:
'git [...] -- [...]''
/mnt/data/Git/pd_backup/doc/source/whatsnew/v1.3.1.rst:65: WARNING: Cannot find contributors for range 'v1.3.0..v1.3.1': Cmd('git') failed due to: exit code(128)
cmdline: git log --grep=Co-authored --pretty=%b v1.3.0..v1.3.1
stderr: 'fatal: ambiguous argument 'v1.3.0..v1.3.1': unknown revision or path not in the working tree.
Use '--' to separate paths from revisions, like this:
'git [...] -- [...]''
/mnt/data/Git/pd_backup/doc/source/whatsnew/v1.3.2.rst:65: WARNING: Cannot find contributors for range 'v1.3.1..v1.3.2': Cmd('git') failed due to: exit code(128)
cmdline: git log --grep=Co-authored --pretty=%b v1.3.1..v1.3.2
stderr: 'fatal: ambiguous argument 'v1.3.1..v1.3.2': unknown revision or path not in the working tree.
Use '--' to separate paths from revisions, like this:
'git [...] -- [...]''
/mnt/data/Git/pd_backup/doc/source/whatsnew/v1.3.3.rst:78: WARNING: Cannot find contributors for range 'v1.3.2..v1.3.3|HEAD': Cmd('git') failed due to: exit code(128)
cmdline: git log --grep=Co-authored --pretty=%b v1.3.2..HEAD
stderr: 'fatal: ambiguous argument 'v1.3.2..HEAD': unknown revision or path not in the working tree.
Use '--' to separate paths from revisions, like this:
'git [...] -- [...]''
WARNING:


Exception in /mnt/data/Git/pd_backup/doc/source/whatsnew/v0.18.0.rst at block ending on line 1006
Specify :okexcept: as an option in the ipython:: block to suppress this message

ValueError Traceback (most recent call last)
in
----> 1 s.between_time("7:00am", "9:00am")

/mnt/data/Git/pd_backup/pandas/core/generic.py in between_time(self, start_time, end_time, include_start, include_end, axis)
7681 raise TypeError("Index must be DatetimeIndex")
7682
-> 7683 indexer = index.indexer_between_time(
7684 start_time, end_time,

</details>

@MarcoGorelli
Copy link
Member

thanks for spotting this - indeed, since the docs were reorganised, "code standards" is in a different page.

Could you also change the pull request template to link to https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit then please?

The build process takes very long on my machine (multiple minutes). Is there a way to make it go faster?
Also, I got the following errors while building, unrelated to what I did:

You can just build the doc page you've edited using --single (this should be somewhere in the contributing guide)

@feefladder
Copy link
Contributor Author

Aah, yes, I was initially thinking of elaborating in the contributing page, which was what this was for. Now this does both.

the --single cannot find the file, I guess that needs more fumbling around ;)

Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

the --single cannot find the file, I guess that needs more fumbling around ;)

can you show the command you ran?

@MarcoGorelli
Copy link
Member

@feefladder
Copy link
Contributor Author

Sorry, I had solved it locally but I didn't know that not all branches get pushed when I git push on another branch.

@MarcoGorelli MarcoGorelli added this to the 1.4 milestone Sep 8, 2021
Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

@mroeschke mroeschke merged commit 819002c into pandas-dev:master Sep 8, 2021
@mroeschke
Copy link
Member

Thanks @joeperdefloep

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.

3 participants