Skip to content

Use lowercased method name convention#9

Merged
jparise merged 2 commits intoInstapaper:mainfrom
jparise:client-methods
Mar 31, 2026
Merged

Use lowercased method name convention#9
jparise merged 2 commits intoInstapaper:mainfrom
jparise:client-methods

Conversation

@jparise
Copy link
Copy Markdown
Member

@jparise jparise commented Mar 31, 2026

This renames the Article, PDF, and Summary methods to lowercase, matching standard Python naming conventions and avoiding any overlap with the model type names.

We have aliases for the previous names for backwards compatibility.

This renames the Article, PDF, and Summary methods to lowercase,
matching standard Python naming conventions and avoiding any overlap
with the model type names.

We have aliases for the previous names for backwards compatibility.
@jparise jparise requested a review from Donohue March 31, 2026 19:44
Copy link
Copy Markdown
Contributor

@Donohue Donohue left a comment

Choose a reason for hiding this comment

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

Approved but before shipping we will need to update this on the Instaparser website homepage, quick start guides, etc.

@Donohue
Copy link
Copy Markdown
Contributor

Donohue commented Mar 31, 2026

On second thought, I think this will break compatibility for older clients? How do you think about that?

@jparise
Copy link
Copy Markdown
Member Author

jparise commented Mar 31, 2026

On second thought, I think this will break compatibility for older clients? How do you think about that?

We have these aliases that allow the existing names to still work:

# Aliases for backwards compatibility:
Article = article
PDF = pdf
Summary = summary

@jparise
Copy link
Copy Markdown
Member Author

jparise commented Mar 31, 2026

In addition to the aliases, we now emit a DeprecationWarning when the old names are used.

@jparise jparise merged commit e82ddae into Instapaper:main Mar 31, 2026
6 checks passed
@jparise jparise deleted the client-methods branch March 31, 2026 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants