Adding inline documentation #16955
Merged
Adding inline documentation #16955
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
While exploring the DashboardsController, I came across method calls to `not_found`. Idiomatically, I assumed that these methods were returning a value. However, in looking at the code, it raises an exception. _Note: I excpect methods that raise exceptions, especially as the only thing they do, to end in a `!`._ By adding the documentation my "IntelliSense" provides insight into the expected behavior of this function (e.g. "Raises an exception"). Without the documentation, I don't see any useful information.
dscottS3
approved these changes
Mar 21, 2022
pr-triage
bot
added
PR: partially-approved
djuber
approved these changes
Mar 21, 2022
pr-triage
bot
added
PR: reviewed-approved
pr-triage
bot
added
PR: merged
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.
What type of PR is this? (check all applicable)
Description
While exploring the DashboardsController, I came across method calls to
not_found. Idiomatically, I assumed that these methods were returninga value. However, in looking at the code, it raises an exception.
Note: I excpect methods that raise exceptions, especially as the only
thing they do, to end in a
!.By adding the documentation my "IntelliSense" provides insight into the
expected behavior of this function (e.g. "Raises an exception").
Without the documentation, I don't see any useful information.
With Inline Docs
The "proposed" state:
Without Inline Docs
The "prior" state.
Related Tickets & Documents
QA Instructions, Screenshots, Recordings
None.
UI accessibility concerns?
None.
Added/updated tests?
[Forem core team only] How will this change be communicated?