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

Confusing function names #51

Closed
fhocutt opened this issue Jul 8, 2014 · 3 comments
Closed

Confusing function names #51

fhocutt opened this issue Jul 8, 2014 · 3 comments
Assignees
@danmichaelo
Milestone
v0.7.0

Comments

@fhocutt
Copy link
Contributor

fhocutt commented Jul 8, 2014

It is confusing that the user calls page.edit() to retrieve the text of a page, and page.save(...) to edit the text of a page. Consider deprecating/renaming these functions to improve usability.
@danmichaelo
Copy link
Member

Suggestions for better names are welcome :)

@fhocutt
Copy link
Contributor Author

fhocutt commented Jul 9, 2014

Changing page.edit to page.text or page.content would be better! Keeping page.save might be ok if page.edit was gone, since changing it to page.edit would be even more confusing.

@danmichaelo danmichaelo added this to the v0.7 milestone Sep 21, 2014
@danmichaelo danmichaelo self-assigned this Sep 21, 2014
danmichaelo added a commit that referenced this issue Sep 21, 2014
@danmichaelo
[#51] Rename Page.edit() to Page.text()
61155f1 
since the method does not edit the page, but returns the text of the
page. The old method name still works, but issues a DeprecationWarning.
Note that DeprecationWarnings are silent by default, so we might
consider to elevate it in some future version.
@danmichaelo
Copy link
Member

I'm considering to change this

@waldyrious waldyrious mentioned this issue Dec 12, 2018
Open
38 tasks
@waldyrious waldyrious mentioned this issue Sep 29, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@danmichaelo danmichaelo

Labels
None yet
Projects
None yet
Milestone
v0.7.0
Development

No branches or pull requests
2 participants
@danmichaelo @fhocutt