Skip to content

Edits for style and sense #2641

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

Edits for style and sense #2641

merged 2 commits into from
Oct 19, 2022

Conversation

LizUpton
Copy link
Contributor

Note we're missing some labels in an image.

Note we're missing some labels in an image.
@aallan aallan added copy edit more than a typo audio 🔊 labels Oct 14, 2022

=== Hardware and wiring

For this project, any small passive speaker should be sufficient, we're using one available https://shop.pimoroni.com/products/3-speaker-4-3w?variant=380549926[here], which is a 3" 4Ω - 5W Speaker. We have also used an illuminated momentary push button button and a laser cut box to house all the components, but both are entirely optional. This example will work just using the Codec Zero on-board button, which is pre-wired to GPIO 27. Alternatively, you may use any momentary push button, such as those available https://shop.pimoroni.com/products/mini-arcade-buttons?variant=40377171274[here].
For this project, any small passive speaker should be sufficient. We're using one available https://shop.pimoroni.com/products/3-speaker-4-3w?variant=380549926[here], which provides 5W of power at 4Ω. We have also used an illuminated momentary push button, and a laser-cut box to house all the components; but both are entirely optional. This example will work just using the Codec Zero's on-board button, which is pre-wired to GPIO 27. (Alternatively, you can use any momentary push button, such as those available https://shop.pimoroni.com/products/mini-arcade-buttons?variant=40377171274[here].)
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if this is the right wording, as the speaker is only a passive device, and so doesn't provide power? Perhaps "which handles 5W of power"? 🤷

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed following your suggestion, @lurch; but I'm still not totally happy with the wording (can't think of anything better, though). Any thoughts, @aallan?


=== Setting up your Raspberry Pi

In this example, we are using Raspberry Pi OS Lite. Our guides on https://www.raspberrypi.com/documentation/computers/getting-started.html#installing-the-operating-system[Getting Started] cover this topic in great detail. Make sure that you update your operating system before proceeding and follow the instructions provided for Codec Zero Configuration, including the commands to enable the on-board microphone and speaker output.
In this example, we are using Raspberry Pi OS Lite. Our guides on https://www.raspberrypi.com/documentation/computers/getting-started.html#installing-the-operating-system[Getting started] cover this topic in great detail. Make sure that you update your operating system before proceeding and follow the instructions provided for Codec Zero configuration, including the commands to enable the on-board microphone and speaker output.
Copy link
Contributor

Choose a reason for hiding this comment

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

Ideally this should be a relative URL rather than an absolute URL.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yup. We should use an xref: here not an absolute link.

Copy link
Contributor

Choose a reason for hiding this comment

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

If you're going to lower case the "s" you need to also lower case the "g"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, because it's title case. (I do love arguing about capitalisation with you though, because I usually win, so keep it up.)

Copy link
Contributor

Choose a reason for hiding this comment

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

Honestly think it should be re-worded to,

In this example, we are using Raspberry Pi OS Lite. Our https://www.raspberrypi.com/documentation/computers/getting-started.html#installing-the-operating-system[getting started] guides cover this topic in great detail.

There's no real reason to Yoda it in the way it's written right now?

Copy link
Contributor

Choose a reason for hiding this comment

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

The text should be readable and make sense grammatically if the link is taken away. Right now that it's the case. The title case thing relies on the fact that this is a link to make it make sense.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why don't we leave this until we're in the same room on Wednesday so this takes two minutes rather than a distributed hour of typing?

@lurch
Copy link
Contributor

lurch commented Oct 14, 2022

There's a "recoding" typo in here which ought to be "recording".

@ghost ghost mentioned this pull request Oct 17, 2022
Merged
@aallan aallan merged commit 4f2b598 into iqaudio Oct 19, 2022
@aallan aallan deleted the LizUpton-patch-2 branch October 19, 2022 15:17
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