markdown + minor content cleanup

pakx commented 4 years ago

Description

These are clerical edits to readme.md, and address warnings emitted by markdownlint absent a lint config and using its defaults devnotes-cleanup-readme-markdown.txt (https://github.com/DavidAnson/vscode-markdownlint). Pls see detailed list of changes in attached devnotes-...txt file

Motivation and Context

Opening readme.md in a linting markdown-editor produces a lot of visual noise (based on lint defaults); these edits address them.

How Has This Been Tested?

running markdownlint-cli now produces warnings only re line-length

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
[x] Documentation change

Checklist:

[x] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly.
[?] I have read all applicable contributing documents.
[ ] I have added tests to cover my changes.
[ ] All new and existing tests passed.
[ ] I have updated the change log (if applicable).

devnotes-cleanup-readme-markdown.txt

pakx commented 4 years ago

That last definition for spec still leaves me w/ questions, plus I'd like a comment on the word "scope" introduced in the definition for streak, plus I agree that some overhaul of concept/terminology would help. However this is getting further afied from the original goal of just cleaning up markup.

How about:

-- i resubmit this as the original PR -- incorporating your original edits for streak/spec if you'd like -- later I can submit a separate PR addressing concepts, terminology, omissions (e.g. the source code shows 2 more assertion types not mentioned in the readme: satisfies, notSatisfies), etc

dead-claudia commented 4 years ago

@pakx How about leaving the changes to streak documentation out for this PR and submitting a followup so we can discuss wording there?

pakx commented 4 years ago

Done. Reverted line 673 referenced here https://github.com/MithrilJS/ospec/files/4965559/devnotes-cleanup-readme-markdown.txt

MithrilJS / ospec