Hotfix: Spelling and Formatting in "Naming Conventions" #5
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
The example is inconsistent with its employee ID. That is, the employee is initially referred to with ID "E13454" and is then retrieved with a GET at `/project-name/v1/employees/E13455`. The latter now ends with `E13454`.
Although there was a heading for "Bad URL examples", there was no equivalent for "Good URL examples" leading it to bleed into the "Date Field Naming Conventions" section. In addition, it also bleeds into the more generic "Managing Dates" section, so a higher-level heading was created called "Examples".
To keep the "Bad URL examples" section consistent with "Good URL examples", HTTP methods were added that were related to the operation they were applying.
jordanwalsh23
approved these changes
Dec 18, 2019
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.
This hotfix introduces some minor fixes to the "Naming Conventions" section where there are minor inconsistencies or missing information.
Of large note are the addition of headings in order to avoid bleeding examples into the "Managing Dates" section. This section may need to be reviewed to meet appropriate standards.