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

fix some text issues with grammar and style #41

Closed
wants to merge 3 commits into from

Conversation

nett00n
Copy link

@nett00n nett00n commented Dec 30, 2023

fix most common markdownlint violations

I have two questions:

  • There are many inline HTML, which are not recommended. I would prefer to fix it before merging this pr.
  • There are badges mentions in footer, but no badges themselves. Is it a bug or feature?

@Zehina
Copy link
Owner

Zehina commented Dec 31, 2023

Hey @nett00n thank you for these improvements. From a first look, all looks great .
So to answer your question:

  • Some HTML is there for the centering I was using.
  • The badges in the footer is a bug indeed and can be removed

I'm currently planning on merging #36 . Which changes the whole structure of the project
so woud you mind either:

  • Porting your changes ta branch based on the new-structure branch and wait for it to merge first
  • Or I can just review this and we can merge and I'll look into the conflicts myself.

Thank you again this is very helpful. But I figured I needed to do some very necessary cleanup first

@nett00n
Copy link
Author

nett00n commented Jan 2, 2024

@Zehina I ported changes to new-structure branch. Here is PR

  1. HTML usage in README.md minified
  2. More linters added
  3. black formatter for *.py added for more style and readability
  4. everything I found had been fixed

@nett00n nett00n closed this Jan 2, 2024
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

Successfully merging this pull request may close these issues.

2 participants