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

Doc updates #2248

Merged
merged 10 commits into from
Feb 17, 2025
Merged

Doc updates #2248

merged 10 commits into from
Feb 17, 2025

Conversation

Sjlver
Copy link
Contributor

@Sjlver Sjlver commented Jan 29, 2025

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Other... Please describe: Documentation update

What is the current behavior?

The readme was outdated in several places. There was no good description of the throttling logic.

What is the new behavior?

I've added a short description of the logic. Also, fixed some stale links and clarified some code examples.

Does this PR introduce a breaking change?

  • Yes
  • No

@Sjlver
Copy link
Contributor Author

Sjlver commented Feb 14, 2025

@jmcdo29 would you have time to take a look at this PR one of these days?

Copy link
Member

@jmcdo29 jmcdo29 left a comment

Choose a reason for hiding this comment

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

From a quick view everything looks good. I might suggest we just link over to the nest docs site, but this works too. Thanks for the updates

@Sjlver
Copy link
Contributor Author

Sjlver commented Feb 17, 2025

Cool, thanks!

@jmcdo29 you'd have to do the actual merge, since I don't have write access to the repository.

@jmcdo29 jmcdo29 merged commit 92a94c5 into nestjs:master Feb 17, 2025
3 checks passed
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