Skip to content

Style #2643

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 1 commit into from
Oct 19, 2022
Merged

Style #2643

merged 1 commit into from
Oct 19, 2022

Conversation

LizUpton
Copy link
Contributor

V minimal changes. Took warning out of ALL CAPS.

V minimal changes. Took warning out of ALL CAPS.
@aallan aallan added copy edit more than a typo audio 🔊 labels Oct 14, 2022

DigiAMP{plus} uses the Texas Instruments TAS5756M PowerDAC and must be powered from an external supply. It requires a 12-24V DC power source (XP Power VEC65US19 power supply is recommended).
DigiAMP{plus} uses the Texas Instruments TAS5756M PowerDAC and must be powered from an external supply. It requires a 12-24V DC power source (the XP Power VEC65US19 power supply is recommended).

image::images/DigiAMP+_Board_Diagram.jpg[width="80%"]

DigiAMP{plus}’s power in barrel connector is 5.5mm x 2.5mm.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is probably the internal and external diameters of the barrel connector, so describing it as "is 5.5mm x 2.5mm." probably isn't right?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's length of the plug, and diameter of the barrel? Umm. This needs clarifying I guess. @tobybroberts do you have actual hardware here to look at and measure things?


image::images/DigiAMP+_Board_Diagram.jpg[width="80%"]

DigiAMP{plus}’s power in barrel connector is 5.5mm x 2.5mm.

At power-on, the amplifier is muted by default (the mute LED is illuminated). Software is responsible for the mute state and LED control (Raspberry Pi GPIO22).

DigiAMP{plus} is designed to provide power to the Raspberry Pi and DigiAMP{plus} together in parallel, delivering 5.1V at 2.5Amp to the Raspberry Pi through the GPIO header.
DigiAMP{plus} is designed to provide power to the Raspberry Pi and DigiAMP{plus} together in parallel, delivering 5.1V at 2.5amp to the Raspberry Pi through the GPIO header.
Copy link
Contributor

Choose a reason for hiding this comment

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

2.5amp -> 2.5A ? 🤷

Copy link
Contributor

Choose a reason for hiding this comment

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

Liz you can't decapitalise Amps, and Amp is an Amp, it is not an amp. It is (a) the name of the person, and (b) the name of the unit. Units named after people are always uppercased in physics. Should be "2.5 A" or "2.5 Amps"

Copy link
Contributor

Choose a reason for hiding this comment

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

You left volts capitalised, so it's "5.1 V" not "5.1 v".

That said engineers have a habit of lowercasing volts, and I will hunt all instances out and fix them. It's V not v, and A not a.

Copy link
Contributor

Choose a reason for hiding this comment

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

And the style-guide also says no space between the number and the unit, so "5.1V" not "5.1 V"

Copy link
Contributor

Choose a reason for hiding this comment

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

mutters

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Al and I have already had the Slack equivalent of a bar fight over this: I intend to continue it in a real bar tomorrow. Style guide says lower-case a, upper-case V, no space (for historical vernacular reasons as laid out by Hart's Rules - also observed yesterday that the Times' and Economist's style guides concur); it's a standard English usage thing rather than a physics/moral rectitude thing.

Honestly (and this is where things start to go wobbly) I don't really like the inconsistency either, but if we make changes now it means that ALL of our materials for the last ten years are affected. And I'm not going to go through and make retrospective changes for consistency.

In short, I might be persuadable on this, but, @aallan, you're going to have amazingly persuasive.

Copy link

Choose a reason for hiding this comment

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

Amp and amp are equally wrong - it should be A.

@lurch
Copy link
Contributor

lurch commented Oct 14, 2022

Took warning out of ALL CAPS.

GOOD JOB LIZ.

@aallan aallan merged commit 4aed396 into iqaudio Oct 19, 2022
@aallan aallan deleted the LizUpton-patch-4 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