search

drowe67 / codec2

Open source speech codec designed for communications quality speech between 700 and 3200 bit/s. The main application is low bandwidth HF/VHF digital radio.
GNU Lesser General Public License v2.1
201 stars 32 forks source link

Fix typos #38

Closed jimt closed 11 months ago

jimt commented 11 months ago

I would also hyphenate a lot more words than you have. Everything from open-source to 8-bit, low-pitched, low-order, fixed-order, post-filtering, time-varying, etc. I am guessing this is a difference between American and Australian English, so I've tried to resist.

Thank you for taking the time to write this! I may finally have a better grasp of the techniques.

drowe67 commented 11 months ago

Hi @jimt - thanks for your fine proof reading (yet again) :slightly_smiling_face:

Can you pls merge your PR with the latest main branch? @timw has just fixed the automated build test for the doc, so when you push, it will run a test to build the doc.

Re hyphenation - I'm actually not sure what to do, I'm just guessing. Is there an external reference or style guide we can refer too? I've also adopted .au spelling (e.g. quantisation) for better or for worse. That was just a random choice too.

jimt commented 11 months ago

Re hyphenation - I'm actually not sure what to do, I'm just guessing. Is there an external reference or style guide we can refer too?

I go by my poorly remembered Chicago Manual of Style rules about compound modifiers, but I see the guidance has changed a bit over the years. I suppose it is best to wait for a real editor to review your document.

drowe67 commented 11 months ago

Thanks @jimt - the test_codec2_doc test ran OK. Are you able to build the pdf and commit it? Instructions are in doc/Makefile. Or let me know if you would like me to.

jimt commented 11 months ago

Please do it for me.

When I tried there were warnings about duplicate table and figure names (in addition to more typical complaints about overfull and underfill boxes). And one no ; in font nullfont so I don't have confidence in my output.

drowe67 commented 11 months ago

Yes it's very verbose. Generally if the PDF gets created all is well. I'll push the latest and greatest in a few days, I'm off on a short vacation :boat:

drowe67 commented 11 months ago

Hi @jimt, so I pulled your branch and rebuilt the PDF (it looks fine) but I can't push to your repository (it keeps requesting my user name). I think you may need to allow changes. This sort of thing is at the edge of my git skills, so failing that we can just merge your changes and I will push the new PDF to main.

tmiw commented 11 months ago

Hi @jimt, so I pulled your branch and rebuilt the PDF (it looks fine) but I can't push to your repository (it keeps requesting my user name). I think you may need to allow changes. This sort of thing is at the edge of my git skills, so failing that we can just merge your changes and I will push the new PDF to main.

I was able to do it via GitHub Desktop. Presumably there's a way to do it via the command prompt as well but /shrug.

BTW I just realized that the current Makefile doesn't work on macOS, but that's something that can be fixed outside of this PR.

drowe67 commented 11 months ago

Hi @jimt, so I pulled your branch and rebuilt the PDF (it looks fine) but I can't push to your repository (it keeps requesting my user name). I think you may need to allow changes. This sort of thing is at the edge of my git skills, so failing that we can just merge your changes and I will push the new PDF to main.

I was able to do it via GitHub Desktop. Presumably there's a way to do it via the command prompt as well but /shrug.

Thanks !

BTW I just realized that the current Makefile doesn't work on macOS, but that's something that can be fixed outside of this PR.

Cool. Or it could perhaps be cmake-i-fied.

drowe67 commented 11 months ago

Oops fumbled the Git buttons! and accidentally closed :slightly_smiling_face: Need more :coffee: