go icon indicating copy to clipboard operation
go copied to clipboard

Allow whitespace in comments

Open twocs opened this issue 3 years ago • 2 comments

Without updating this test, the comments in go fail. For example, this should be a valid package description comment (assuming it was for weather not builtin):

/*
	Package builtin provides documentation for Go's predeclared identifiers.
	The items documented here are not actually in package builtin
	but their descriptions here allow godoc to present documentation
	for the language's special identifiers.
*/

Note that there is a tab before the comment text in go core. This tab causes the test to fail. The fix is to simply use the TrimSpaces (which was already applied), and it will ignore tabs, spaces, and new lines.

twocs avatar Aug 10 '22 08:08 twocs

Dear twocs

Thank you for contributing to the Go track on Exercism! 💙 You will see some automated feedback below 🤖. It would be great if you can make sure your PR covers those points. This will save your reviewer some time and your change can be merged quicker.

  • 🔗 If your PR fully fixes an issue, please include the text Fixes #issue_no in any line of the PR description. This will make the issue be automatically be closed when the PR is merged. If your PR is related to an existing issue but does not fix it completely, please link the issue anywhere in the description of the PR with #issue_no. You can read more about this in Github: Linking a pull request to an issue

  • ✍️ If your PR is not related to an existing issue (and is not self-explaining like a typo fix), please make sure the description explains why the change you made is necessary.

  • 🔤 If your PR fixes an easy to identify typo, if would be great if you could check for that typo in the whole repo. For example, if you found Unicdoe, use "replace all" in your editor (or command line magic) to fix it consistently.

Dear Reviewer/Maintainer

  • 📏 Make sure you set the appropriate x:rep label for the PR. (This also works after merging, in case you forgot about it.)

  • 🔍 Don't be too nit-picky. If the PR is a clear improvement compared to the status quo, it should be approved as clear signal this is good to be merged even if the minor comments you might have are not addressed by the contributor. Further improvement ideas can be captured in issues (if important enough) and implemented via additional PRs.

  • 🤔 After reviewing the diff in the "Files changed" section, take a moment to think about whether there are changes missing from the diff. Does something need to be adjusted in other places so the code or content stays consistent?

Automated comment created by PR Commenter 🤖.

github-actions[bot] avatar Aug 10 '22 08:08 github-actions[bot]

Updated tests were submitted by @andrerfcsantos. His exercise with block comment passed the tests, but only because they were far to the left without tabs, unlike the core doc go comments. See a failed test here on Iteration 2: https://exercism.org/tracks/go/exercises/weather-forecast/solutions/twocs

Iteration 1 was successful

twocs avatar Aug 11 '22 01:08 twocs