Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding inline documentation #16955

Merged
merged 1 commit into from Mar 21, 2022
Merged

Adding inline documentation #16955

merged 1 commit into from Mar 21, 2022

Commits on Mar 21, 2022

  1. Adding inline documentation

    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.
    jeremyf committed Mar 21, 2022
    Copy the full SHA
    a57f5e3 View commit details
    Browse the repository at this point in the history