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

Add documentation for dynamic route parameters in custom routes #1791

Merged
merged 12 commits into from
Apr 4, 2023

Conversation

zimeg
Copy link
Member

@zimeg zimeg commented Apr 1, 2023

Summary

This PR adds supporting documentation to the "Adding custom HTTP routes" section for the enhancements made in #1785. The documentation links out to the official Express documentation for more details, and provides a simple example to showcase this feature.

Requirements

@zimeg zimeg added the docs M-T: Documentation work only label Apr 1, 2023
@zimeg zimeg added this to the 3.13.0 milestone Apr 1, 2023
@zimeg zimeg requested a review from seratch April 1, 2023 00:36
@zimeg zimeg self-assigned this Apr 1, 2023
@codecov
Copy link

codecov bot commented Apr 1, 2023

Codecov Report

Merging #1791 (77337d8) into main (2b3b929) will not change coverage.
The diff coverage is n/a.

❗ Current head 77337d8 differs from pull request most recent head b740f97. Consider uploading reports for the commit b740f97 to get more accurate results

@@           Coverage Diff           @@
##             main    #1791   +/-   ##
=======================================
  Coverage   82.27%   82.27%           
=======================================
  Files          18       18           
  Lines        1523     1523           
  Branches      441      441           
=======================================
  Hits         1253     1253           
  Misses        172      172           
  Partials       98       98           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@seratch seratch modified the milestones: 3.13.0, 3.12.3 Apr 1, 2023
docs/_advanced/custom_routes.md Outdated Show resolved Hide resolved
@zimeg
Copy link
Member Author

zimeg commented Apr 3, 2023

@seratch The requested updates have been made and the version number in these docs has been changed to v3.12.3. Thank you for looking at this, and please let me know if there are more changes to make!

@zimeg zimeg requested a review from seratch April 3, 2023 20:30
@seratch
Copy link
Member

seratch commented Apr 3, 2023

The requested updates have been made and the version number in these docs has been changed to v3.12.3. Thank you for looking at this, and please let me know if there are more changes to make!

It might be confusing but I've moved this to the existing v3.12.3 and renamed it to v3.13.0 after that. So, the next version is till v3.13.0. The reason why I reused the existing one is that it already had 13 issues/PRs in it and I didn't want to move it one by one 😄

Either way, please forget the version number 3.12.3 -- you can make v3.13 release with these changes!

Copy link
Member

@seratch seratch left a comment

Choose a reason for hiding this comment

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

Looks good to me but I'd recommend merging this PR after releasing a new version including the feature addition

@zimeg
Copy link
Member Author

zimeg commented Apr 3, 2023

It might be confusing but I've moved this to the existing v3.12.3 and renamed it to v3.13.0 after that.

@seratch Ahh I completely missed that! Sneaky yet sensible 😏 I'll hold off on merging until the new version is released 👍

@zimeg zimeg merged commit 32d34c4 into main Apr 4, 2023
@zimeg zimeg deleted the 1785-document-dynamic-custom-routes branch April 4, 2023 23:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants