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

docs(series): streamline documentation #242

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

yamcodes
Copy link
Contributor

@yamcodes yamcodes commented Sep 11, 2024

Tip

The owner of this PR can publish a preview release by commenting /publish in this PR. Afterwards, anyone can try it out by running pnpm add radashi@pr<PR_NUMBER>.

Summary

The documentation for series contains a typo ("let's" instead of "lets") and has poor grammatical flow. This PR fixes it by making the documentation for the function more digestible.

Related issue, if any:

For any code change,

  • Related documentation has been updated, if needed
  • Related tests have been added or updated, if needed
  • Related benchmarks have been added or updated, if needed

Does this PR introduce a breaking change?

No

@yamcodes yamcodes changed the title docs(series): Streamline documentation docs(series): streamline documentation Sep 11, 2024
@MarlonPassos-git MarlonPassos-git added the documentation Improvements or additions to documentation label Sep 11, 2024
Copy link
Contributor

@MarlonPassos-git MarlonPassos-git left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants