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.

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

Clean up the public API #382

Merged
merged 2 commits into from
Nov 22, 2024
Merged

Clean up the public API #382

merged 2 commits into from
Nov 22, 2024

Conversation

macjuul
Copy link
Contributor

@macjuul macjuul commented Nov 22, 2024

Thank you for submitting this pull request! We appreciate you spending the time to work on these changes.

What is the motivation?

Some functions and classes are undocumented, inconsistent, or unclear

What does this change do?

  • Add documentation to most of the public facing API
  • Moved ident escaping functions to a dedicated util file
  • Renamed functions to adhere to JavaScript conventions
    • Previous names are still available, albeit marked as deprecated

What is your testing strategy?

CI

Is this related to any issues?

If this pull request is related to any other pull request or issue, or resolves any issues - then link all related pull requests and issues here.

Have you read the Contributing Guidelines?

@macjuul macjuul requested a review from kearfy as a code owner November 22, 2024 14:08
@macjuul macjuul merged commit 77a874e into main Nov 22, 2024
12 checks passed
@macjuul macjuul deleted the update/api branch November 22, 2024 14: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.

1 participant