You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2023/01/18 00:05:16 UTC
[GitHub] [beam] lukecwik opened a new pull request, #25048: Don't validate trailing whitespace for *.md files.
lukecwik opened a new pull request, #25048:
URL: https://github.com/apache/beam/pull/25048
Markdown file has certain lines that have trailing whitespace and they are legitimate as a way to prevent markdown rendering from collapsing the newlines.
This is a follow-up on #24951
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] Mention the appropriate issue in your description (for example: `addresses #123`), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment `fixes #<ISSUE NUMBER>` instead.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://beam.apache.org/contribute/get-started-contributing/#make-the-reviewers-job-easier).
To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
GitHub Actions Tests Status (on master branch)
------------------------------------------------------------------------------------------------
[](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] lukecwik closed pull request #25048: Don't validate trailing whitespace for *.md files.
Posted by GitBox <gi...@apache.org>.
lukecwik closed pull request #25048: Don't validate trailing whitespace for *.md files.
URL: https://github.com/apache/beam/pull/25048
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] codecov[bot] commented on pull request #25048: Don't validate trailing whitespace for *.md files.
Posted by GitBox <gi...@apache.org>.
codecov[bot] commented on PR #25048:
URL: https://github.com/apache/beam/pull/25048#issuecomment-1386280192
# [Codecov](https://codecov.io/gh/apache/beam/pull/25048?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) Report
> Merging [#25048](https://codecov.io/gh/apache/beam/pull/25048?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (059f056) into [master](https://codecov.io/gh/apache/beam/commit/f40057b7fb68ca556be7fbd0cc420311937dcf80?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (f40057b) will **increase** coverage by `0.00%`.
> The diff coverage is `n/a`.
```diff
@@ Coverage Diff @@
## master #25048 +/- ##
=======================================
Coverage 73.12% 73.12%
=======================================
Files 735 735
Lines 98151 98151
=======================================
+ Hits 71774 71776 +2
+ Misses 25013 25011 -2
Partials 1364 1364
```
| Flag | Coverage Δ | |
|---|---|---|
| python | `82.68% <ø> (+<0.01%)` | :arrow_up: |
Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#carryforward-flags-in-the-pull-request-comment) to find out more.
| [Impacted Files](https://codecov.io/gh/apache/beam/pull/25048?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) | Coverage Δ | |
|---|---|---|
| [...on/apache\_beam/runners/dataflow/dataflow\_runner.py](https://codecov.io/gh/apache/beam/pull/25048?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c2Rrcy9weXRob24vYXBhY2hlX2JlYW0vcnVubmVycy9kYXRhZmxvdy9kYXRhZmxvd19ydW5uZXIucHk=) | `81.88% <0.00%> (+0.14%)` | :arrow_up: |
| [...python/apache\_beam/runners/worker/worker\_status.py](https://codecov.io/gh/apache/beam/pull/25048?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c2Rrcy9weXRob24vYXBhY2hlX2JlYW0vcnVubmVycy93b3JrZXIvd29ya2VyX3N0YXR1cy5weQ==) | `76.66% <0.00%> (+0.66%)` | :arrow_up: |
:mega: We’re building smart automated test selection to slash your CI/CD build times. [Learn more](https://about.codecov.io/iterative-testing/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] lukecwik commented on pull request #25048: Don't validate trailing whitespace for *.md files.
Posted by GitBox <gi...@apache.org>.
lukecwik commented on PR #25048:
URL: https://github.com/apache/beam/pull/25048#issuecomment-1386264361
R: @kennknowles
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] lukecwik commented on a diff in pull request #25048: Don't validate trailing whitespace for *.md files.
Posted by GitBox <gi...@apache.org>.
lukecwik commented on code in PR #25048:
URL: https://github.com/apache/beam/pull/25048#discussion_r1081958868
##########
sdks/python/test-suites/tox/py38/build.gradle:
##########
@@ -120,7 +120,6 @@ task archiveFilesToLint(type: Zip) {
destinationDirectory = file("$buildDir/dist")
from ("$rootProject.projectDir") {
- include "**/*.md"
Review Comment:
I'm indifferent, just wanted to merge a solution to get the build back to green.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] lukecwik commented on pull request #25048: Don't validate trailing whitespace for *.md files.
Posted by GitBox <gi...@apache.org>.
lukecwik commented on PR #25048:
URL: https://github.com/apache/beam/pull/25048#issuecomment-1387445937
Closed in favor of https://github.com/apache/beam/pull/25055, can always revert that and get this in.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] kennknowles commented on a diff in pull request #25048: Don't validate trailing whitespace for *.md files.
Posted by GitBox <gi...@apache.org>.
kennknowles commented on code in PR #25048:
URL: https://github.com/apache/beam/pull/25048#discussion_r1081938409
##########
sdks/python/test-suites/tox/py38/build.gradle:
##########
@@ -120,7 +120,6 @@ task archiveFilesToLint(type: Zip) {
destinationDirectory = file("$buildDir/dist")
from ("$rootProject.projectDir") {
- include "**/*.md"
Review Comment:
Empty line has a different effect. Line break tags are fine with me.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] github-actions[bot] commented on pull request #25048: Don't validate trailing whitespace for *.md files.
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #25048:
URL: https://github.com/apache/beam/pull/25048#issuecomment-1386283808
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] damccorm commented on a diff in pull request #25048: Don't validate trailing whitespace for *.md files.
Posted by GitBox <gi...@apache.org>.
damccorm commented on code in PR #25048:
URL: https://github.com/apache/beam/pull/25048#discussion_r1073643348
##########
sdks/python/test-suites/tox/py38/build.gradle:
##########
@@ -120,7 +120,6 @@ task archiveFilesToLint(type: Zip) {
destinationDirectory = file("$buildDir/dist")
from ("$rootProject.projectDir") {
- include "**/*.md"
Review Comment:
Most style guides seem to recommend against this as well (I only sampled 3, but they all agree):
- https://arcticicestudio.github.io/styleguide-markdown/rules/whitespace.html
- https://www.markdownguide.org/basic-syntax/#line-break-best-practices
- https://google.github.io/styleguide/docguide/style.html#trailing-whitespace
I put up #25055 as an alternative
##########
sdks/python/test-suites/tox/py38/build.gradle:
##########
@@ -120,7 +120,6 @@ task archiveFilesToLint(type: Zip) {
destinationDirectory = file("$buildDir/dist")
from ("$rootProject.projectDir") {
- include "**/*.md"
Review Comment:
I'd vote we keep this rule, especially for markdown. While trailing whitespace in markdown is meaningful, its also an antipattern IMO - its an invisible change to reviewers that changes the rendering of the document in a meaningful way, and many IDEs will remove it automatically on save. A better way to do this IMO is to insert an empty line or a break tag.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org