Skip to content

[pigeon] doc comments always start with ' ' - #2825

Merged
auto-submit[bot] merged 4 commits into
flutter:mainfrom
tarrinneal:fixDocCom
Nov 19, 2022
Merged

auto-submit[bot] merged 4 commits into
flutter:mainfrom
tarrinneal:fixDocCom

Conversation

@tarrinneal

Copy link
Copy Markdown
Contributor

adds a space to all documentation comments that do not start with a space to avoid issues with languages that use */ to close block comments.

List which issues are fixed by this PR. You must list at least one issue.
fixes flutter/flutter#115657

If you had to change anything in the flutter/tests repo, include a link to the migration guide as per the breaking change policy.

Pre-launch Checklist
I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
I signed the CLA.
The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
I listed at least one issue that this PR fixes in the description above.
I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.
I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
All existing and new tests are passing.

Comment thread packages/pigeon/pigeons/message.dart Resolved

@gaaclarke gaaclarke left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM. As a nit I think you could have gotten away with just testing the function you edited directly instead of at all the points in the generators. I think it would be cleaner and easier to maintain since the change would have a specific test associated with it.

@tarrinneal

tarrinneal commented Nov 19, 2022 •

Copy link
Copy Markdown
Contributor Author

LGTM. As a nit I think you could have gotten away with just testing the function you edited directly instead of at all the points in the generators. I think it would be cleaner and easier to maintain since the change would have a specific test associated with it.

Good point, I just thought it made sense to add it with the other doc comment tests. I'll look into that change in the future.

I also thought this was closer to integration style testing.

@tarrinneal tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Nov 19, 2022
@auto-submit
auto-submit Bot merged commit 04a5444 into flutter:main Nov 19, 2022
creatorpiyush pushed a commit to creatorpiyush/packages that referenced this pull request Jun 10, 2026
* doc comments always start with ' '

* add unit tests

* remove unused import

* small test scaffolding fix to allow publish
bisor0627 pushed a commit to bisor0627/packages that referenced this pull request Jun 19, 2026
* doc comments always start with ' '

* add unit tests

* remove unused import

* small test scaffolding fix to allow publish
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmit Merge PR when tree becomes green via auto submit App p: pigeon

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[pigeon] Comments starting with //// break compilation of generated code using C++-style blocks

2 participants