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

Documentation (man/flac.md); fix typo #644

Merged

Conversation

Lee-Carre
Copy link
Contributor

@Lee-Carre Lee-Carre commented Sep 2, 2023

Section: Apodization functions § partial_tukey

From:

The use of this is that different parts of a block are ignored as the might contain transients which are hard to predict anyway. […]

to (emphasis added only in this summary, not in the source):

The use of this is that different parts of a block are ignored as they might contain transients which are hard to predict anyway. […]


FYI: I'm a Git newbie, so hopefully I've done this correctly.

Section: `Apodization functions`

From:

> For partial_tukey(n) and punchout_tukey(n), […] The use of this is that different parts of a block are ignored as the might contain transients which are hard to predict anyway. […]

to (emphasis added only in this summary, not in the source):

> For partial_tukey(n) and punchout_tukey(n), […] The use of this is that different parts of a block are ignored as the**y** might contain transients which are hard to predict anyway. […]
@Lee-Carre Lee-Carre marked this pull request as ready for review September 2, 2023 18:32
@ktmf01
Copy link
Collaborator

ktmf01 commented Sep 3, 2023

Thanks!

FYI: I'm a Git newbie, so hopefully I've done this correctly.

Looks good to me. One thing I will fix for now which you could improve next time, is wrap the length of the commit message lines at 72 characters. So, instead of

> For partial_tukey(n) and punchout_tukey(n), […] The use of this is that different parts of a block are ignored as the might contain transients which are hard to predict anyway. […]

You could do

> For partial_tukey(n) and punchout_tukey(n), […] The use of this is
> that different parts of a block are ignored as the might contain
> transients which are hard to predict anyway. […]

But I'll fix that for now.

@ktmf01 ktmf01 merged commit 2a29eae into xiph:master Sep 3, 2023
@Lee-Carre
Copy link
Contributor Author

Looks good to me.

Thankyou.

wrap the length of the commit message lines at 72 characters

A hard-limit seems unwise, to me. Software should (at display-time) word-wrap based on the display environment, so that lines are a sensible length for everyone.

If there's a legit reason, significant enough to ignore sound accessibility & usability guidelines, then I'll consider it. A pointer to reading material would be fine.

If it's for a change-log, or similar, that has some excellent reason for a hard limit, then that could be implemented in software, too.

The downside to hard line lengths, is that if one has a wide display, then much more scrolling is involved. Letting their software display text how they want, keeps them in control of their own reading experience. Plus, it breaks the likes of grep when searching for multi-word phrases which span a hard line-break.

@ktmf01
Copy link
Collaborator

ktmf01 commented Sep 10, 2023

wrap the length of the commit message lines at 72 characters

A hard-limit seems unwise, to me. Software should (at display-time) word-wrap based on the display environment, so that lines are a sensible length for everyone.

I didn't invent it, that is the convention when working with git as far as I know. git doesn't do word wrap by itself.

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 this pull request may close these issues.

2 participants