DOC: Validating that the word pandas is correctly capitalized #32613

joybh98 · 2020-03-11T04:48:02Z

closes DOC: Standardize references to pandas in the documentation #32316
tests added / passed
passes black pandas
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

As suggested by @datapythonista , I've added checks in ci/code_checks.sh to look if the pandas is being referenced in a standardized way i.e pandas, not *pandas* or Pandas

@datapythonista I've only added checks to see if pandas is being referenced correctly, but not showing where it's changed or how many references are wrong.
Should I add checks for that also ? What do you think ?

datapythonista · 2020-03-11T10:33:17Z

Can you have a look at the diff? I think something went wrong, there are lots of unrelated changes.

joybh98 · 2020-03-11T15:19:38Z

@datapythonista you're right, let me check what went wrong.

ShaharNaveh · 2020-03-11T16:10:50Z

@joybhallaa Can you run the following and push?

git checkout add-check-standard-pandas
git fetch upstream
git merge upstream/master
git reset --soft upstream/master
git commit -m "Fixed wrong diff"

Taken all of the commands above from https://datapythonista.me/blog/useful-git-commands.html

joybh98 · 2020-03-12T00:55:19Z

@MomIsBestFriend okay, I'll do that !

joybh98 · 2020-03-12T02:09:57Z

git checkout add-check-standard-pandas
git fetch upstream
git merge upstream/master
git reset --soft upstream/master
git commit -m "Fixed wrong diff"

@MomIsBestFriend I executed all these commands, and when pushing using git push origin add-check-standard-pandas, I got the error hint: Updates were rejected because the tip of your current branch is behind hint: its remote counterpart. Integrate the remote changes (e.g. hint: 'git pull ...') before pushing again. hint: See the 'Note about fast-forwards' in 'git push --help' for details.

Let me check what's causing the problem and I'll push ASAP

ShaharNaveh · 2020-03-12T07:54:43Z

@joybhallaa Have you followed the steps in the Contributing guide?

datapythonista · 2020-03-12T15:26:27Z

@joybhallaa first try git diff upstream/master and see if now you've got the changes you're proposing in this PR. If that's the case, you need a git push --force, since you're rewriting the history here (replacing all these unwanted commits by the new single commit you just did).

joybh98 · 2020-03-17T19:24:59Z

@joybhallaa first try git diff upstream/master and see if now you've got the changes you're proposing in this PR. If that's the case, you need a git push --force, since you're rewriting the history here (replacing all these unwanted commits by the new single commit you just did).

@datapythonista done

datapythonista

You are adding this code in the linting section (flake8...). We have a section named patterns where we are checking for many patterns in the same way as you need to check for this one.

datapythonista · 2020-03-18T10:59:42Z

ci/code_checks.sh

@@ -80,6 +80,13 @@ if [[ -z "$CHECK" || "$CHECK" == "lint" ]]; then
    flake8-rst doc/source --filename=*.rst --format="$FLAKE8_FORMAT"
    RET=$(($RET + $?)) ; echo $MSG "DONE"

+    # Check if pandas is referenced as pandas, not *pandas* or Pandas
+    MSG='Checking if pandas reference is standardized or not' ; echo  $MSG


Suggested change

MSG='Checking if pandas reference is standardized or not' ; echo $MSG

MSG='Checking if the pandas word is always used lowercase (has to be pandas, not Pandas or PANDAS...)' ; echo $MSG

datapythonista · 2020-03-18T11:03:21Z

ci/code_checks.sh

+    # Check if pandas is referenced as pandas, not *pandas* or Pandas
+    MSG='Checking if pandas reference is standardized or not' ; echo  $MSG
+    grep -nr '*pandas*|Pandas' doc/*
+    grep -nr '*pandas*|Pandas' web/*


I guess the next code works. You can't have two statements, since you are checking the exit code later, and you're only checking the code of the last statement.

Suggested change

grep -nr '*pandas*|Pandas' web/*

grep -nr '*pandas*|Pandas' web/* doc/*

Also, please use invgrep as in the rest of this script, you're doing here the opposite of what you want to do. And we have lots of validations where we already do this for other patterns, don't need to reinvent the wheel, just so the same, so we also keep consistent.

datapythonista · 2020-03-18T11:04:41Z

ci/code_checks.sh

+    grep -nr '*pandas*|Pandas' web/*
+    RET=$(($RET + $?)) ; echo $MSG "DONE"
+
+


Don't leave extra blank lines, keep the same style and formatting as the rest of the script.

datapythonista · 2020-03-23T09:44:06Z

@joybhallaa do you have time to have a look at the previous comments?

joybh98 · 2020-03-23T09:45:56Z

@datapythonista yep was busy with college stuff. Will start work ASAP

joybh98 · 2020-03-24T12:39:11Z

ci/code_checks.sh

@@ -229,6 +229,11 @@ if [[ -z "$CHECK" || "$CHECK" == "patterns" ]]; then
    invgrep -RI --exclude=\*.{svg,c,cpp,html,js} --exclude-dir=env "\s$" *
    RET=$(($RET + $?)) ; echo $MSG "DONE"
    unset INVGREP_APPEND
+
+    # Check if pandas is referenced as pandas, not *pandas* or Pandas
+    MSG='Checking if the pandas word reference is always used lowercase (pandas,not Pandas or PANDAS' ; echo  $MSG


@datapythonista I forgot to add ) on line 234, please let me know if everything else besides this right or not.

datapythonista

CI is green, and I don't think we fixed all the cases of Pandas and *pandas* in the docs and web, did we? If we didn't, this is not working.

We use invgrep -R everywhere else, I think we should use the same, may be that's the problem.

Also, can you add PANDAS please?

ShaharNaveh · 2020-03-24T21:46:06Z

ci/code_checks.sh

+
+    # Check if pandas is referenced as pandas, not *pandas* or Pandas
+    MSG='Checking if the pandas word reference is always used lowercase (pandas,not Pandas or PANDAS' ; echo  $MSG
+    invgrep -nr '*pandas*|Pandas' web/* doc/*


I think the problem is with the astriks in the end, does the CI fail if we remove those?

Let me check

@MomIsBestFriend CI passes even after removing the asterisk

joybh98 · 2020-03-31T07:13:26Z

CI is green, and I don't think we fixed all the cases of Pandas and *pandas* in the docs and web, did we? If we didn't, this is not working.

We use invgrep -R everywhere else, I think we should use the same, may be that's the problem.

Also, can you add PANDAS please?

Sure

datapythonista · 2020-03-31T13:37:22Z

Something is wrong here, @joybhallaa can you have a look at the diff, and leave things so this is ready for review please?

* CLN: cimporting time instead of going to python space pandas/_libs/tslibs/conversion.pyx * cimporting time instead of going to python space pandas/_libs/tslibs/timestamps.pyx * cimporting time instead of going to python space pandas/_libs/tslibs/period.pyx Co-authored-by: MomIsBestFriend <>

… needed) (pandas-dev#32823)

…andas-dev#33133)

Co-authored-by: Farhan Reynaldo <[email protected]>

…andas-dev#33107)

…andas-dev#33074) * TYP: require _update_inplace gets BlockManager * standardize on requiring Series/DataFrame, never BlockManager

joybh98 · 2020-04-01T04:48:30Z

@datapythonista yes.Working on it right now

EDIT: There is still one file with conflict.

joybh98 · 2020-04-01T08:55:28Z

@datapythonista should I open a new PR with a new branch ? This branch keeps giving me problems.

ShaharNaveh · 2020-04-01T09:36:17Z

@joybhallaa I suggest you read https://datapythonista.me/blog/useful-git-commands.html

I've got some cool changes, but my history is a mess

joybh98 · 2020-04-01T12:33:17Z

@datapythonista the 2nd last commit only has the changes that I've made.
Let me know if that's suitable

datapythonista · 2020-04-01T15:36:21Z

@datapythonista the 2nd last commit only has the changes that I've made.
Let me know if that's suitable

No, we need a proper PR to be able to fix. @MomIsBestFriend gave you a resource to fix this. But probably better to open a new PR, closing this one, since your changes are small, and looks like it'll be easier to start again, than to fix this.

datapythonista changed the title ~~[TST] Added checks for standardized pandas~~ DOC: Validating that the word pandas is correctly capitalized Mar 11, 2020

datapythonista added CI Continuous Integration Docs labels Mar 11, 2020

Fixed wrong diff

591cdc6

joybh98 force-pushed the add-check-standard-pandas branch from 6be9787 to 591cdc6 Compare March 17, 2020 19:24

datapythonista requested changes Mar 18, 2020

View reviewed changes

added requested changes

4665b01

joybh98 commented Mar 24, 2020

View reviewed changes

datapythonista reviewed Mar 24, 2020

View reviewed changes

ShaharNaveh reviewed Mar 24, 2020

View reviewed changes

joybh98 and others added 2 commits March 31, 2020 12:59

added -R and PANDAS

019544a

CI: add doctest check for done modules (pandas-dev#33175)

0fbdf48

jbrockmendel and others added 6 commits March 31, 2020 09:39

REF: .get tests (pandas-dev#33164)

927dedb

DOC: Partial fix SA04 errors in docstrings pandas-dev#28792 (feedback…

e56d395

… needed) (pandas-dev#32823)

REF: fillna tests (pandas-dev#33183)

cc3f3eb

Json parametrize more2 (pandas-dev#33163)

4d0eef6

CLN: use ._data less in reshape (pandas-dev#33159)

cb41651

jbrockmendel and others added 16 commits March 31, 2020 12:48

BUG: isna_old with td64, dt64tz, period (pandas-dev#33158)

51f114b

REF: .drop tests (pandas-dev#33156)

aa71c21

REF: test_reindex_like (pandas-dev#33150)

a7dd3ea

BUG: create new MI from MultiIndex._get_level_values (pandas-dev#33134)

f10ec59

BUG: to_datetime with infer_datetime_format dropped timezone names (p…

6a8aca9

…andas-dev#33133)

DOC: Fix capitalization of doc section headers (pandas-dev#33149)

c166013

DOC: Fix capitalization of docs section headers (pandas-dev#32944)

a6c610d

DOC: Fix PR06 (type names) in docstrings (pandas-dev#33093)

8305a85

Co-authored-by: Farhan Reynaldo <[email protected]>

TST: cover search_sorted scalar mixed timezones case (pandas-dev#33185)

98a2aa3

DOC: Added docstring for show_versions() (pandas-dev#33073)

f148cb7

REF: set_axis tests (pandas-dev#33189)

cbd1103

ENH/VIZ: Allowing s parameter of scatter plots to be a column name (p…

1357114

…andas-dev#33107)

misplaced sort-index test (pandas-dev#33191)

f303665

Correct docstring to describe actual functionality. (pandas-dev#33190)

af0c878

REF/CLN: test_get_dummies (pandas-dev#33184)

d8d1dc9

TYP: require _update_inplace gets Frame/Series, never BlockManager (p…

49bc8d8

…andas-dev#33074) * TYP: require _update_inplace gets BlockManager * standardize on requiring Series/DataFrame, never BlockManager

fixed merge conflicts

8c73b5f

joybh98 added 2 commits April 1, 2020 17:35

All changes in a single commit

6daedb0

fixed merge conflict in test_unstack.py

b332532

datapythonista closed this Apr 1, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Validating that the word pandas is correctly capitalized #32613

DOC: Validating that the word pandas is correctly capitalized #32613

joybh98 commented Mar 11, 2020 •

edited by datapythonista

Loading

datapythonista commented Mar 11, 2020

joybh98 commented Mar 11, 2020

ShaharNaveh commented Mar 11, 2020

joybh98 commented Mar 12, 2020

joybh98 commented Mar 12, 2020

ShaharNaveh commented Mar 12, 2020

datapythonista commented Mar 12, 2020

joybh98 commented Mar 17, 2020

datapythonista left a comment

datapythonista Mar 18, 2020

datapythonista Mar 18, 2020

datapythonista Mar 18, 2020

datapythonista commented Mar 23, 2020

joybh98 commented Mar 23, 2020

joybh98 Mar 24, 2020

datapythonista left a comment

ShaharNaveh Mar 24, 2020

joybh98 Mar 31, 2020

joybh98 Mar 31, 2020

joybh98 commented Mar 31, 2020 •

edited

Loading

datapythonista commented Mar 31, 2020

joybh98 commented Apr 1, 2020 •

edited

Loading

joybh98 commented Apr 1, 2020

ShaharNaveh commented Apr 1, 2020

joybh98 commented Apr 1, 2020

datapythonista commented Apr 1, 2020

	MSG='Checking if pandas reference is standardized or not' ; echo $MSG
	MSG='Checking if the pandas word is always used lowercase (has to be pandas, not Pandas or PANDAS...)' ; echo $MSG

	grep -nr 'pandas\|Pandas' web/*
	grep -nr 'pandas\|Pandas' web/* doc/*

		grep -nr 'pandas\|Pandas' web/*
		RET=$(($RET + $?)) ; echo $MSG "DONE"

DOC: Validating that the word pandas is correctly capitalized #32613

DOC: Validating that the word pandas is correctly capitalized #32613

Conversation

joybh98 commented Mar 11, 2020 • edited by datapythonista Loading

datapythonista commented Mar 11, 2020

joybh98 commented Mar 11, 2020

ShaharNaveh commented Mar 11, 2020

joybh98 commented Mar 12, 2020

joybh98 commented Mar 12, 2020

ShaharNaveh commented Mar 12, 2020

datapythonista commented Mar 12, 2020

joybh98 commented Mar 17, 2020

datapythonista left a comment

Choose a reason for hiding this comment

datapythonista Mar 18, 2020

Choose a reason for hiding this comment

datapythonista Mar 18, 2020

Choose a reason for hiding this comment

datapythonista Mar 18, 2020

Choose a reason for hiding this comment

datapythonista commented Mar 23, 2020

joybh98 commented Mar 23, 2020

joybh98 Mar 24, 2020

Choose a reason for hiding this comment

datapythonista left a comment

Choose a reason for hiding this comment

ShaharNaveh Mar 24, 2020

Choose a reason for hiding this comment

joybh98 Mar 31, 2020

Choose a reason for hiding this comment

joybh98 Mar 31, 2020

Choose a reason for hiding this comment

joybh98 commented Mar 31, 2020 • edited Loading

datapythonista commented Mar 31, 2020

joybh98 commented Apr 1, 2020 • edited Loading

joybh98 commented Apr 1, 2020

ShaharNaveh commented Apr 1, 2020

joybh98 commented Apr 1, 2020

datapythonista commented Apr 1, 2020

joybh98 commented Mar 11, 2020 •

edited by datapythonista

Loading

joybh98 commented Mar 31, 2020 •

edited

Loading

joybh98 commented Apr 1, 2020 •

edited

Loading