Skip to content

DOC: var and std missing examples #44162

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
Closed
1 task done
AnshuTrivedi opened this issue Oct 24, 2021 · 2 comments · Fixed by #44274
Closed
1 task done

DOC: var and std missing examples #44162

AnshuTrivedi opened this issue Oct 24, 2021 · 2 comments · Fixed by #44274
Labels
Docs good first issue
Milestone
1.4

Comments

@AnshuTrivedi
Copy link

AnshuTrivedi commented Oct 24, 2021 •
edited
Loading

  • I have checked that the issue still exists on the latest versions of the docs on master here

Location of the documentation

https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.var.html
https://pandas.pydata.org/docs/dev/reference/api/pandas.DataFrame.std.html

Screenshot (1178)

Documentation problem

In all other APIs in DataFrame at least one example is given for better understanding.
I believe, function description is also available in notebooks but not any example.
It's good to have one example for mentioned APIs.

Suggested fix for documentation

Fix: Use of atleast one example for better undertanding of function.
It's better because function description along with example creates clarity of its use and implimentation.
@AnshuTrivedi AnshuTrivedi added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Oct 24, 2021
@attack68
Copy link
Contributor

Sure, fancy contributing a PR?

@attack68 attack68 removed the Needs Triage Issue that has not been reviewed by a pandas team member label Oct 24, 2021
@attack68 attack68 added this to the Contributions Welcome milestone Oct 24, 2021
@ruankie ruankie mentioned this issue Oct 24, 2021
Closed
1 task
@phofl phofl changed the title DOC: DOC: var and std missing examples Oct 24, 2021
@AshiJoshi AshiJoshi removed their assignment Oct 27, 2021
@ruankie ruankie mentioned this issue Oct 29, 2021
Merged
4 tasks
@MarcoGorelli
Copy link
Member

std is done in #44226, so there's still space for a PR for var

@ruankie ruankie mentioned this issue Nov 1, 2021
Merged
3 tasks
mroeschke pushed a commit that referenced this issue Nov 6, 2021
@ruankie @MarcoGorelli
DOC: added examples to DataFrame.var #44162 (#44274)
5304048 
* DOC: added examples to DataFrame.std

* DOC: fixed PEP compliance in DataFrame.std examples

* DOC: inserted examples into docs for pandas.DataFrame.std

* Update pandas/core/generic.py

* Update pandas/core/generic.py

* DOC: punctuation fix in pandas/core/generic.py

* DOC: whitespace fix in pandas/core/generic.py

* DOC: whitespace fix in pandas/core/generic.py

* DOC: added two examples to the docstring of pandas.DataFrame.var

* DOC: punctuation fix in docstring of pandas.DataFrame.var

* DOC: minor changes to docstring of pandas.DataFrame.var

Co-authored-by: Marco Edward Gorelli <[email protected]>
@mroeschke mroeschke modified the milestones: Contributions Welcome, 1.4 Nov 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs good first issue
Projects
None yet
Milestone
1.4
Development

Successfully merging a pull request may close this issue.

DOC: added examples to DataFrame.var #44162 ruankie/pandas
5 participants
@mroeschke @attack68 @AshiJoshi @MarcoGorelli @AnshuTrivedi