Skip to content
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

Jump to bottom

DOC: Added docstrings to fixtures defined in XML I/O, util and pandas modules #56524

Merged
merged 4 commits into from
Jan 12, 2024
Merged

DOC: Added docstrings to fixtures defined in XML I/O, util and pandas modules #56524

merged 4 commits into from
Jan 12, 2024

Conversation

CristianoS16
Copy link
Contributor

@CristianoS16 CristianoS16 commented Dec 16, 2023 •
edited
Loading

Partially addresses: #19159

Co-authored-by: @GeorgeJuniorGG and @MylenaRoberta.

CristianoS16 and others added 3 commits December 16, 2023 15:19
@CristianoS16 @GeorgeJuniorGG @MylenaRoberta
docs: add documentation to xml conftest file fixtures
3ad30c5 
Co-authored-by: GeorgeJuniorGG <g216741@dac.unicamp.br>
Co-authored-by: MylenaRoberta <m222687@dac.unicamp.br>
@CristianoS16 @GeorgeJuniorGG @MylenaRoberta
docs: add documentation to util conftest file fixtures
620a269 
Co-authored-by: GeorgeJuniorGG <g216741@dac.unicamp.br>
Co-authored-by: MylenaRoberta <m222687@dac.unicamp.br>
@CristianoS16 @GeorgeJuniorGG @MylenaRoberta
docs: add documentation to pandas conftest arrow_string_storage fixture
656b5fa 
Co-authored-by: GeorgeJuniorGG <g216741@dac.unicamp.br>
Co-authored-by: MylenaRoberta <m222687@dac.unicamp.br>
@datapythonista datapythonista added Testing pandas testing functions or related to the test suite Docs labels Dec 17, 2023
datapythonista
datapythonista reviewed Dec 17, 2023
View reviewed changes
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution @CristianoS16, good work, I added some suggestions that you can have a look at. Note that I only add the suggestions once, but for example having the constant values True or False with backticks is something that can apply to several docstring in your changes.

pandas/tests/io/xml/conftest.py Outdated Show resolved Hide resolved
pandas/tests/io/xml/conftest.py Outdated Show resolved Hide resolved
pandas/tests/util/conftest.py Outdated Show resolved Hide resolved
pandas/tests/util/conftest.py Outdated Show resolved Hide resolved
pandas/tests/util/conftest.py Outdated Show resolved Hide resolved
@CristianoS16 @GeorgeJuniorGG @MylenaRoberta
doc: apply suggestions
52d7d5c 
Co-authored-by: GeorgeJuniorGG <g216741@dac.unicamp.br>
Co-authored-by: MylenaRoberta <m222687@dac.unicamp.br>
@CristianoS16
Copy link
Contributor Author

Thanks for the contribution @CristianoS16, good work, I added some suggestions that you can have a look at. Note that I only add the suggestions once, but for example having the constant values True or False with backticks is something that can apply to several docstring in your changes.

Thanks @datapythonista for the suggestions. I think we fixed it!

@datapythonista datapythonista merged commit e6d0c1a into pandas-dev:main Jan 12, 2024
38 checks passed
@datapythonista
Copy link
Member

Thank you @CristianoS16 for the contribution, nice work, and sorry for the delay.

pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
@CristianoS16 @pmhatre1
DOC: Added docstrings to fixtures defined in XML I/O, util and pandas…
40fd5b9 
… modules (pandas-dev#56524)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@datapythonista datapythonista Awaiting requested review from datapythonista

Assignees
No one assigned
Labels
Docs Testing pandas testing functions or related to the test suite
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@CristianoS16 @datapythonista