Skip to content

Style, rewording #2642

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

Merged
merged 2 commits into from
Oct 19, 2022
Merged

Style, rewording #2642

merged 2 commits into from
Oct 19, 2022

Conversation

LizUpton
Copy link
Contributor

A spot of edit for length too.

A spot of edit for length too.
@aallan aallan added copy edit more than a typo audio 🔊 labels Oct 14, 2022
PRO/DAC{plus}/DigiAMP{plus})
This can be achieved by ensuring the 'Audio output' section of `/etc/mpd.conf` has the 'mixer_control'
line. Below is an example for the Texas Instruments-based boards (DAC
PRO/DAC{plus}/DigiAMP{plus}):
Copy link
Contributor

Choose a reason for hiding this comment

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

Feels a bit uncomfortable with no spaces between the slashes here? (or maybe that's just me)
Also, "Texas Instruments-based boards" feels like a level of technical detail that the users shouldn't need to know?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, the TI bit had me vacillating when I did the first pass. I'll kill it. Slashes/spaces is a style guide thing; no spaces for consistency.

Not fixing the TI reference for now; another one for a sit-down conversation.

* The rotary encoders we have used and tested are the Alpha three-pin rotary encoder
RE160F-40E3-20A-24P, the ALPS EC12E2430804 (RS: 729-5848), and the Bourns ECW0JB24-AC0006L (RS: 263-2839).
* The barrel connector used for powering the DigiAMP{plus} is 2.5mmID, 5.5mmOD, 11mm.
Copy link
Contributor

Choose a reason for hiding this comment

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

Space between 'mm' and 'ID' and 'OD'?

Copy link
Contributor

Choose a reason for hiding this comment

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

@aallan More discussion about the barrel connector here ☝️

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh yeah, ID and OD. Interesting.

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

We should describe it (in both places) like this then, "via a DC 5521 centre positive barrel connector (5.5mm × 2.1mm × 11mm)" assuming it is a centre positive barrel?

Copy link
Contributor

Choose a reason for hiding this comment

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

...except the connector here has a 2.5mm inside diameter, which is different to the Build HAT's 2.1mm inside diameter 😜

Copy link
Contributor

Choose a reason for hiding this comment

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

...and this is why we all hate barrel jacks

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This one also requires a conversation in person. Let's talk tomorrow.

@lurch
Copy link
Contributor

lurch commented Oct 18, 2022

IMHO the whole "Using external USB devices" section ought to be chopped out.

@aallan
Copy link
Contributor

aallan commented Oct 18, 2022

The FAQ isn't (shouldn't) be displayed any more. I asked @toby to integrate anything relevant into the text.

The existence of a FAQ is a failure of the documentation, it is not in itself documentation.

AFAIK this file should just be deleted as it isn't used any more.

@lurch
Copy link
Contributor

lurch commented Oct 18, 2022

Bizarrely the file is named faq.adoc, but there don't actually seem to be any FAQs in there? 🤔
(so yes, the post-copy-edited content here should probably be moved into other files.)

@aallan aallan merged commit 5f9e7c0 into iqaudio Oct 19, 2022
@aallan aallan deleted the LizUpton-patch-3 branch October 19, 2022 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
audio 🔊 copy edit more than a typo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants