Skip to content

Added the GH Issue number note to Writing Tests in Docs #28705

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 3 commits into from
Closed

Added the GH Issue number note to Writing Tests in Docs #28705

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
567bc64
Added the GH Issue number note to Writing Tests in Docs
KiranAkadas Oct 1, 2019
f907864
Added the note with example
KiranAkadas Oct 1, 2019
6c04c15
Added the note with example (corrected)
KiranAkadas Oct 2, 2019
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
9 changes: 9 additions & 0 deletions doc/source/development/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -949,6 +949,15 @@ the expected correct result::

assert_frame_equal(pivoted, expected)

.. note::

Add the GitHub issue number as a comment to the new tests.
For Example - For a test solving issue number 20172, write
| # GH 20172
Copy link
Member

Choose a reason for hiding this comment

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

Should move this to the function body. Check the test as an example in #28662 if needed

| def test_apply_categorical_with_nan_values(self, series):
| s = pd.Series(series, dtype="category")
| ...

Transitioning to ``pytest``
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down