[
https://issues.apache.org/jira/browse/BEAM-11693?focusedWorklogId=542542&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-542542
]
ASF GitHub Bot logged work on BEAM-11693:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 27/Jan/21 01:09
Start Date: 27/Jan/21 01:09
Worklog Time Spent: 10m
Work Description: lostluck commented on pull request #13815:
URL: https://github.com/apache/beam/pull/13815#issuecomment-767937579
While i agree in principle, I'm of the mind that since I'm going to be
making the next half dozen changes to this one markdown file, that at the very
least it should be more consistent than it is with itself.
A sentence per line is far less manual work than maintaining specific
character counts per line. Otherwise each change means reflowing the rest of
the paragraph.
Unless we can agree on a markdown formatter that we can *just run* from
gradle. Given we have a whitepace lint that doesn't actually fix the problem,
I'm inclined to believe we don't have one such thing at present.
Further, when i run the whitepace linter it operates even on the git
submodules which we likely don't want to get in the habit of formatting.
Besides: the common case is not reading the source, it's reading the
rendered site which handles the flows properly anyway. Qhen editing, one would
commonly be in an editor which can handle the user's wrapping preference.
Finally, if one is searching for a specific line to change, as long as your
don't search on sentence breaks, you're easily able to Ctrl-F for the specific
line. With arbitrarily broken up text (like max 80 char lines) to character
counts, you don't know if you can't find a snippet due to a typo, or due to a
line break in the text your looking for.
Your preference is noted but I strongly disagree with the sysyphean effort
proposed by manually maintaining 80 char flows without automation.
That we don't currently impose a standard still means that imposing one
consistently for this single file is a dramatic improvement over it's current
state of 3-4 different approaches.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 542542)
Time Spent: 20m (was: 10m)
> Post 2.26.0 Release Tasks
> -------------------------
>
> Key: BEAM-11693
> URL: https://issues.apache.org/jira/browse/BEAM-11693
> Project: Beam
> Issue Type: Improvement
> Components: project-management, website
> Reporter: Robert Burke
> Assignee: Robert Burke
> Priority: P2
> Time Spent: 20m
> Remaining Estimate: 0h
>
> Umbrella Jira for updates to the release guide based on [~lostluck]'s
> experience releasing 2.26.0.
> # Improve the formatting consistency of the release documentation
> ## Formatting of the markdown version (eg. WRT linebreaks).
> ## Improve readability of sections through bolding highlighting.
> ## Grammar errors and typos.
> # Improve the getting started tasks (be explicit on installed dependencies
> up front. and other environment assumptions).
> # Make the use of arbitrary version numbers consistent / Glossary of
> SCRIPT_SUBSTITUTIONS at the top.
> # Describe the "big picture" of a release to get the manager better situated.
> Anything else while I'm editing that can help.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
