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

README.md doesn't describe how pdd handles multi lines comments #224

Closed
php-coder opened this issue Jun 9, 2023 · 0 comments · Fixed by #237
Closed

README.md doesn't describe how pdd handles multi lines comments #224

php-coder opened this issue Jun 9, 2023 · 0 comments · Fixed by #237

Comments

@php-coder
Copy link
Contributor

php-coder commented Jun 9, 2023

The example on README.md seems outdated:

/**
 * @todo #234:15m/DEV This is something to do later
 *  in one of the next releases. I can't figure out
 *  how to implement it now, that's why the puzzle.
 */
void sendEmail() {
  throw new UnsupportedOperationException();
}

while it works, pdd doesn't require a leading space on the next paragraphs, so the following also works:

/**
 * @todo #234:15m/DEV This is something to do later
 * in one of the next releases. I can't figure out
 * how to implement it now, that's why the puzzle.
 */
void sendEmail() {
  throw new UnsupportedOperationException();
}

It would be nice:

  1. update the example to remove a leading space as it isn't required anymore
  2. describe pdd logic of handling multilines comments
  3. provide an example of mixing a @todo comment and non-pdd comment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant