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

README: Re-wrap and improve formatting #189

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

waldyrious
Copy link

@waldyrious waldyrious commented Feb 13, 2021

  • Mention the abbreviation "GAE" next to the first occurrence of the expanded expression (this one comes from Updated the readme #179)
  • Wrap consistently at 80 characters (there were various limits used in different parts of the document)
  • Fix multi-line list item (subsequent lines had to be indented to be considered part of the same list item)
  • Add missing code formatting with backticks
  • Consistently use double backticks for inline code
  • Consistently use two blank lines above section headers
  • Fix a typo ("int the" → "in the")
  • Fix capitalization in mid-sentence parenthetical
  • Consistently indent code blocks with 4 space characters
  • Remove space before :: to match the dominant style in the document

- Mention the abbreviation "GAE" next to the first occurrence of the
  expanded expression
- Wrap consistently at 80 characters (there were various limits used
  in different parts of the document)
- Fix multi-line list item (subsequent lines had to be indented to be
  considered part of the same list item)
- Add missing code formatting with backticks
- Consistently use double backticks for inline code
- Consistently use two blank lines above section headers
- Fix a typo ("int the" → "in the")
- ix capitalization in mid-sentence parenthetical
@Abhishek-IOT
Copy link

The check might not have been completed because of the docker limit has reached.
https://github.com/sympy/sympy-live/issues/188

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