Skip to content

DOC: Encourage use of pre-commit in the docs #30864

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 2 commits into from
Jan 10, 2020

Conversation

gfyoung
Copy link
Member

@gfyoung gfyoung commented Jan 9, 2020

Previously, we stated it as merely optional.

xref #30773, #30814

@gfyoung gfyoung added the Docs label Jan 9, 2020
@gfyoung gfyoung force-pushed the pre-commit-docs-encourage branch from abe5a82 to b01b99b Compare January 9, 2020 20:36
@gfyoung gfyoung changed the title DOC: Encourage use of pre-commit instead of stating as optional DOC: Encourage use of pre-commit in the docs Jan 9, 2020
@gfyoung gfyoung added this to the 1.0.0 milestone Jan 9, 2020
@gfyoung gfyoung force-pushed the pre-commit-docs-encourage branch from b01b99b to 087c704 Compare January 9, 2020 21:46
@simonjayhawkins simonjayhawkins modified the milestones: 1.0.0, 1.1 Jan 9, 2020
@WillAyd
Copy link
Member

WillAyd commented Jan 9, 2020

lgtm. Having not really use pre-commit that much does it also play nicely with VSCode? Probably the route most first-time contributors come through so just want to make sure it doesn't add complications there

@gfyoung gfyoung force-pushed the pre-commit-docs-encourage branch from 087c704 to 73ab6ef Compare January 10, 2020 08:23
@jorisvandenbossche
Copy link
Member

does it also play nicely with VSCode?

What possible complications do you think of?
The pre-commit hook runs a few checks. Either you have already enable flake8 and black in vscode, and then the pre-commit won't complain, or you do not have auto-formatting enabled, and the pre-commit hook will reformat for black / print the errors for flake8 (this what I do, works fine).

I suppose if you have black auto-formatting enabled in vscode, you could run into problems with different configurations?

@gfyoung
Copy link
Member Author

gfyoung commented Jan 10, 2020

I suppose if you have black auto-formatting enabled in vscode, you could run into problems with different configurations?

You can disable plugins by workspace in VSCode, so I wouldn't consider this an issue.

https://code.visualstudio.com/docs/editor/extension-gallery#_disable-an-extension

@gfyoung gfyoung merged commit d1b9598 into pandas-dev:master Jan 10, 2020
@gfyoung gfyoung deleted the pre-commit-docs-encourage branch January 10, 2020 23:52
keechongtan added a commit to keechongtan/pandas that referenced this pull request Jan 13, 2020
…ndexing-1row-df

* upstream/master: (284 commits)
  CLN: leftover ix checks (pandas-dev#30951)
  CI: numpydev changed double to single quote (pandas-dev#30952)
  DOC: Fix whatsnew contributors section (pandas-dev#30926)
  STY: wrong placed space in strings (pandas-dev#30940)
  TYP: type up parts of series.py (pandas-dev#30761)
  DOC: Fix SS03 docstring error (pandas-dev#30939)
  CLN: remove unnecesary _date_check_type (pandas-dev#30932)
  DOC: Fixture docs in pandas/conftest.py (pandas-dev#30917)
  CLN: F-strings (pandas-dev#30916)
  replace syntax with f-string (pandas-dev#30919)
  BUG: pickle files left behind by tm.round_trip_pickle (pandas-dev#30906)
  TYP: offsets (pandas-dev#30897)
  TYP: typing annotations (pandas-dev#30901)
  WEB: Remove from roadmap moving the docstring script (pandas-dev#30893)
  WEB: Removing Discourse links (pandas-dev#30890)
  DOC: Encourage use of pre-commit in the docs (pandas-dev#30864)
  DEPR: fix missing stacklevel in pandas.core.index deprecation (pandas-dev#30878)
  CLN: remove unnecessary overriding in subclasses (pandas-dev#30875)
  RLS: 1.0.0rc0
  BUG: validate Index data is 1D + deprecate multi-dim indexing (pandas-dev#30588)
  ...

# Conflicts:
#	doc/source/whatsnew/v1.0.0.rst
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.

4 participants