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

[next-major] Remove traces of CamelCase #200

Open
rgaudin opened this issue Sep 7, 2024 · 2 comments · May be fixed by #212
Open

[next-major] Remove traces of CamelCase #200

rgaudin opened this issue Sep 7, 2024 · 2 comments · May be fixed by #212
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@rgaudin
Copy link
Member

rgaudin commented Sep 7, 2024

As libzim uses CamelCase, we sometimes followed the convention to stick to the pure-wrapper way.
Given case is not that important and we don't follow it everywhere (it's become minor overtime), we should just remove the remaining traces and use snake case everywhere.

It's a tiny change but obviously breaks the API so should not be merged until approaching next major release

# writer
    def config_nbworkers(self, nbWorkers: int) -> Self: ...  # noqa: N803
    def set_mainpath(self, mainPath: str) -> Self: ...  # noqa: N803
    def add_redirection(
        self,
        path: str,
        title: str,
        targetPath: str,  # noqa: N803
        hints: dict[Hint, int],
    ) -> None: ...
    def add_alias(
        self,
        path: str,
        title: str,
        targetPath: str,  # noqa: N803
        hints: dict[Hint, int],
    ) -> None: ...
# suggestion
    def getEstimatedMatches(self) -> int: ...  # noqa: N802
# search
    def getEstimatedMatches(self) -> int: ...  # noqa: N802
    def getResults(self, start: int, count: int) -> SearchResultSet: ...  # noqa: N802
@rgaudin rgaudin added enhancement New feature or request good first issue Good for newcomers labels Sep 7, 2024
@SrisharanVS
Copy link

There are also some traces of Pascal case, is it better to change them to snake case too?

@rgaudin
Copy link
Member Author

rgaudin commented Sep 16, 2024

There are also some traces of Pascal case, is it better to change them to snake case too?

Indeed

@elfkuzco elfkuzco linked a pull request Nov 29, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

remove traces of camelCase in API elfkuzco/python-libzim
2 participants
@rgaudin @SrisharanVS