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

Typo ':' after Advantages & Features in readme #63

Open
FreshAlacrity opened this issue Feb 28, 2022 · 1 comment
Open

Typo ':' after Advantages & Features in readme #63

FreshAlacrity opened this issue Feb 28, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation ToDo solution known, but not implemented yet

Comments

@FreshAlacrity
Copy link

There's a colon in the readme which appears to be a typo:

<!--Advantages include<sup>(sorted by importance; skip the rest as soon as you're convinced!</sup>-->:

should probably be just:

<!--Advantages include<sup>(sorted by importance; skip the rest as soon as you're convinced!</sup>-->

In both Chrome and Firefox browsers for me the colon only appears after the section has been expanded, and when it does appear it is on the line after the summary/header. Since there is a colon in the sentence introducing the section ("Here is a (not necessarily extensive) list of its advantages and features:") already and because it drops down in that way, it seems out of place.

On a more personal note, thank you for being so open to feedback, even on tiny things. As somebody new to GitHub, I wouldn't have been brave enough to make a note of it here without your very welcoming and friendly invitation to do so.

Thank you so much for making this project and for making it open source! Your project was the first google result for me when I searched 'github markdown to HTML' for a project I'm starting on, and I'm very glad to have found it.

@phseiff phseiff added documentation Improvements or additions to documentation ToDo solution known, but not implemented yet labels Mar 3, 2022
@phseiff
Copy link
Owner

phseiff commented Mar 3, 2022

Hi,

thank you so much for taking the time to tell me, i will fix this as soon as i find time to work on this project's readme again!

Also I'm really glad that my invitation fulfilled its purpose.

I wouldn't have been brave enough to make a note of it here without your very welcoming and friendly invitation to do so.

In my experience (if it helps), commenting and contributing to small-ish GitHub projects in the worst case results in either not getting a response for a while (e.g. due to the maintainer not being all that active on GitHub), or in getting some extremely short response, but i don't think it's usual to encounter active hostility for commenting on github projects so i wouldn't worry too much about it.

Also I'm so glad to hear that my project moved up so far in the google search results, I really didn't expect that!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ToDo solution known, but not implemented yet
Projects
None yet
Development

No branches or pull requests

2 participants