增加 route_boards 相關註解 #195
Merged
增加 route_boards 相關註解 #195
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## development #195 +/- ##
===============================================
+ Coverage 39.32% 43.00% +3.68%
===============================================
Files 22 25 +3
Lines 1030 1286 +256
===============================================
+ Hits 405 553 +148
- Misses 565 647 +82
- Partials 60 86 +26
Continue to review full report at Codecov.
|
|
LGTM |
unknowntpo
commented
Apr 28, 2021
Comment on lines
13
to
15
| // getBoardList get the board list for user with userID | ||
| // Request URL: /v1/boards | ||
| // API Doc: https://pttapp.cc/swagger/#/%E7%9C%8B%E6%9D%BF%E9%83%A8%E5%88%86/get_v1_boards |
There was a problem hiding this comment.
我覺得我們需要統一一個關於 handler 的註解格式，
例如我這裡用
// getBoardList ...
// Request URL: /v1/boards
// API Doc: ...
在 #142 用的是
// getUserFavorites is a http handler function which will get favorite list of user with userID
// to w. request path should be /v1/users/{{user_id}}/favorites
// Please see: ...
There was a problem hiding this comment.
那 Request URL: 的部分呢？
另外，註解格式是否可以放在 documentation 內，方便大家參考？
There was a problem hiding this comment.
註解格式可以考慮放在 doc 裡，不過要放在哪裡又是一個要討論的點。
而且現在也沒有要求貢獻者寫註解，我個人是覺得還好。
Change title: API Doc to Please see.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
👏 解決掉的 issue / Resolved Issues
📝 相關的 issue / Related Issues
⛏ 變更內容 / Details of Changes