Feature/documentation basePath prefix fix - closes #694 #698
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
4 tasks
| @@ -1,24 +1,30 @@ | |||
| JsonRoutes.add("get", "api/:id/swagger.json", function (request, response, next) { | |||
|
|
|||
| // Get current id | |||
| var id = request.params.id; | |||
There was a problem hiding this comment.
What id is this? Please be more specific with variable names, as it improves readability. Be sure to update your comment with a more specific description.
|
This looks good. There are just a couple of minor issues relating to readability. |
|
Added suggested changes to the working branch. |
| @@ -1,24 +1,30 @@ | |||
| JsonRoutes.add("get", "api/:id/swagger.json", function (request, response, next) { | |||
|
|
|||
| // Get current apiDocument Id | |||
| var id = request.params.id; | |||
There was a problem hiding this comment.
Go ahead and change the variable name to apiDocumentId. It is important that variable names are semantic, since they are used throughout the souce. I.e. all lines of source should be semantic as well as comments.
brylie
added a commit
that referenced
this pull request
Dec 9, 2015
…fix-fix Feature/documentation basePath prefix fix - closes #694
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.
No description provided.