Skip to content

Added a check for standard documentation #33592

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.

Sign up for GitHub

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
wants to merge 7 commits into from
Closed

Added a check for standard documentation #33592

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7586ee5
Creating a check for standard documentation
willie3838 Apr 16, 2020
0e13061
Adding a check for standard documentation
willie3838 Apr 16, 2020
6b6180c
Removed trailing whitespaces
willie3838 Apr 16, 2020
692f8eb
Removed trailing whispaces on line 284
willie3838 Apr 16, 2020
5102a97
Added new line after done
willie3838 Apr 17, 2020
2a7b85a
Adding space after last line
willie3838 Apr 22, 2020
190fa65
Added code to the ### PATTERNS ### section
willie3838 Apr 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,4 +378,13 @@ if [[ -z "$CHECK" || "$CHECK" == "typing" ]]; then
fi


exit $RET
### Checking for standardized documentation ###
echo "Checking which files in pandas/doc/source have standardized documentation"
Copy link
Member

Choose a reason for hiding this comment

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

I think this check should go under the ### PATTERNS ### further up this file.

Could you also follow the pattern those checks have?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed!

for entry in $(find ../doc/source/ -type f)
do
if grep -q Pandas "$entry" || grep -q *pandas* "$entry" ; then
echo "$entry"
fi
done

exit $RET
Copy link
Contributor

Choose a reason for hiding this comment

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

think you need a newline here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry I'm not too sure what you mean, I'm new to this. Do you want me to add a new line after done?

Copy link
Member

Choose a reason for hiding this comment

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

Do you want me to add a new line after done?

yes please

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have added a new line after done as requested!

Copy link
Member

Choose a reason for hiding this comment

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

@willie3838 think you added the new line in the wrong spot. Should come at the end of this line not preceding

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@willie3838 think you added the new line in the wrong spot. Should come at the end of this line not preceding

I have added your solution, let me know if it still does not resolve the issue.

Copy link
Member

Choose a reason for hiding this comment

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

There needs to be a newline at the end of this file