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

Grammatical and formatting opportunities #817

Open
abergquist opened this issue Feb 22, 2024 · 3 comments
Open

Grammatical and formatting opportunities #817

abergquist opened this issue Feb 22, 2024 · 3 comments

Comments

@abergquist
Copy link

Please see the attached document for various grammatical and formatting opportunities.
Bluetooth LE plugin for Xamarin and MAUI.docx

All edits are in red.

The only thing that might need explanation is the red right arrows that end in a red vertical line; they indicate a request to indent all the lines that are immediately to the right of the entire vertical line (in all cases, it's some type of code).

Note also that I marked a few edits with a dark (black) checkmark; that indicates that that was an edit that was resolved in an earlier issue (Issue #813).

@smsissuechecker
Copy link

Hi @abergquist,

I'm the friendly issue checker.
It seems like (100.00 %) you haven't used our issue template 😢 I think it is very frustrating for the repository owners, if you ignore them.

If you think it's fine to make an exception, just ignore this message.
But if you think it was a mistake to delete the template, please close the issue and create a new one.

Thanks!

@janusw
Copy link
Member

janusw commented Feb 22, 2024

Please see the attached document for various grammatical and formatting opportunities.

Wow, thanks for taking such a careful look at our README, but actually hand-written notes on a printed-out version of the document are a very old-school way of reporting such issues 😆

It would be much more useful (read: easier to handle) if you could open a pull request that fixes the formatting problems you found.

Also, I'm afraid that comments like "move to the next page" are not very suitable, since the README file is not actually optimized for being printed out in A4 (or any other format), and this is nothing we will be aiming for.

@abergquist
Copy link
Author

No problem, @janusw; I'll be gone for a few days. I'll work on this next week. Thanks.

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

No branches or pull requests

3 participants