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

Add missing @throws to docblocks #2668

Merged
merged 2 commits into from
Apr 27, 2019

Conversation

RyanNerd
Copy link
Contributor

Related: @return type in NotFound.php had wrong types in docblock (fixed)

Closes #2666

Related: @return type in NotFound.php had wrong type in docblock (fixed)
Copy link
Member

@l0gicgate l0gicgate left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we import the exceptions at the top instead of using the \Exception annotation. I'd like to keep the doc blocs as cohesive as possible. Right now some have them and some don't. Also, put a line return after last @param and @return

use Exception;

/**
 * @param ...
 *
 * @return ...
 *
 * @throws Exception
 */

@coveralls
Copy link

Coverage Status

Coverage remained the same at 97.314% when pulling 1b6df21 on RyanNerd:add-throws-2-doc-blocks into 833fea9 on slimphp:3.x.

RyanNerd added a commit to RyanNerd/Slim that referenced this pull request Apr 27, 2019
- Add missing `@throws`
  - Closes: slimphp#2666

- Format DocBlocks to be cohesive
  - Use imports instead of \ClassName
  - Line return after last `@param` and `@return`

  ```
  use Exception;

  /**
   * @param ...
   *
   * @return ...
   *
   * @throws Exception
   */
  ```

  Closes slimphp#2668
@RyanNerd RyanNerd mentioned this pull request Apr 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Slim\App docblocks have missing throws annotations
3 participants