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

Fixed issue #1410 #1458

Merged
merged 7 commits into from Dec 21, 2020
Merged

Fixed issue #1410 #1458

merged 7 commits into from Dec 21, 2020

Conversation

dplefevre
Copy link
Contributor

This addresses issue #1410 "trim_user" and "exclude_replies" missing from user_timeline docstring.

Reviewed and tested these options, and updated api.rst and parameters.rst

Harmon758
Harmon758 requested changes Dec 19, 2020
View reviewed changes
Copy link
Member

@Harmon758 Harmon758 left a comment

Choose a reason for hiding this comment

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

This PR only updates the documentation and doesn't actually add the allowed parameters that the documentation would reflect.

Also the erroneous documentation for the page parameter needs to be removed, as it was never an allowed parameter for this method.

Additionally, include_entities should be added as an allowed parameter, with corresponding documentation as well, as it's also missing.

It might also be worth reordering count to be the first allowed parameter for consistency with the API's documentation and for simpler usage of the method.

docs/api.rst Outdated Show resolved Hide resolved
docs/parameters.rst Outdated Show resolved Hide resolved
@Harmon758 Harmon758 added the Need Follow-Up This needs to be followed up on to be actionable label Dec 19, 2020
@dplefevre
Copy link
Contributor Author

Thank you for the feedback. I believe I have addressed all of the issues you raised in my latest push. Please have a look and let me know if you need any additional changes. Full disclosure, this is my first attempt at an open source contribution, so I hope you do not mind being a bit patient with me.

Harmon758
Harmon758 requested changes Dec 21, 2020
View reviewed changes
Copy link
Member

@Harmon758 Harmon758 left a comment

Choose a reason for hiding this comment

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

Full disclosure, this is my first attempt at an open source contribution, so I hope you do not mind being a bit patient with me.

No problem, that's what reviews are for.

docs/api.rst Outdated Show resolved Hide resolved
@dplefevre @Harmon758
Update docs/api.rst
883118f 
Co-authored-by: Harmon <Harmon758@gmail.com>
@Harmon758 Harmon758 added Documentation This is regarding the library's documentation Improvement This is regarding an improvement to an existing feature and removed Need Follow-Up This needs to be followed up on to be actionable labels Dec 21, 2020
@Harmon758 Harmon758 merged commit 686d4e3 into tweepy:master Dec 21, 2020
@Harmon758 Harmon758 added this to the 3.10 milestone Dec 21, 2020
@Harmon758
Copy link
Member

Thanks for the contribution!

@Harmon758 Harmon758 mentioned this pull request Dec 21, 2020
Closed
@dplefevre dplefevre deleted the doc_fix branch December 26, 2020 03:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Harmon758 Harmon758 Harmon758 approved these changes

Assignees
No one assigned
Labels
Documentation This is regarding the library's documentation Improvement This is regarding an improvement to an existing feature
Projects
None yet
Milestone
3.10
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@dplefevre @Harmon758