labstack / echox

Echo cookbook and website
https://echo.labstack.com
MIT License
406 stars 286 forks source link

Document path paramater behaviour for same path across different methods #254

Closed bruc3mackenzi3 closed 1 year ago

bruc3mackenzi3 commented 1 year ago

While registering a path across multiple methods I discovered all must use the same path paramater name. I only found mention of this unexpected behaviour in GitHub issues (see here and here for e.g.) and figured it's worth calling out in the docs.

aldas commented 1 year ago

Actually this "feature" has been resolved in master with https://github.com/labstack/echo/pull/2209 and will be included in next minor/patch release

bruc3mackenzi3 commented 1 year ago

Actually this "feature" has been resolved in master with labstack/echo#2209 and will be included in next minor/patch release

In that case do you think it's worth mentioning this in the documentation, or forego this PR altogether?

I'm interested in making more contributions to Echo. Are there any particular areas that could use more documentation?

aldas commented 1 year ago

@bruc3mackenzi3 I'll merge this PR but could you make PR that removes this part. So I would have something waiting when next Echo release is tagged.

If you want to improve docs. I think binding page needs some love - I think that new binder could have better formatting tables (supported types). and if you happen to be native English speaker - maybe check and improve weird looking/sounding sentences. I am not native speaker and a lot of our contributors are not. Also there are probably "features" from couple of last releases that are not reflected in docs.

bruc3mackenzi3 commented 1 year ago

@aldas done, PR #255 is ready for you to merge when the time comes :)

Thanks for the suggestions! I can take a look at the Binding page. I see the list of supported types would look better in a table.

As it happens I am a native English speaker. I will chip away at improving grammar and wording as I read over the docs.