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

Multiple @throws do not have the same formatting rules as @param #26

Open
slaFFik opened this issue Jan 6, 2023 · 0 comments
Open

Multiple @throws do not have the same formatting rules as @param #26

slaFFik opened this issue Jan 6, 2023 · 0 comments

Comments

@slaFFik
Copy link
Member

slaFFik commented Jan 6, 2023

Consider this snippet:

 * @param string $email     The subscriber's current email address.
 * @param string $new_email The subscriber's new email address.
 *
 * @throws ResponseException Invalid response.
 * @throws RequiredArgumentMissingException Required argument is missing.

It looks inconsistent in the same phpdoc where we enforce special formatting for @param.

I think this looks better:

 * @param string $email     The subscriber's current email address.
 * @param string $new_email The subscriber's new email address.
 *
 * @throws ResponseException                Invalid response.
 * @throws RequiredArgumentMissingException Required argument is missing.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant