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.

Sign up for GitHub

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

Jump to bottom

Convert readme / changelog from rst to markdown #59

Closed
miketheman opened this issue Mar 30, 2021 · 0 comments · Fixed by #62
Closed

Convert readme / changelog from rst to markdown #59

miketheman opened this issue Mar 30, 2021 · 0 comments · Fixed by #62
Assignees
@miketheman
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@miketheman
Copy link
Owner

This project was born in mid-2017, before PEP-566 was adopted, and before the PEP rolled out to be widely-supported.

This causes a barrier to contribution if anyone wants to update the README or CHANGELOG and isn't familiar with reStructuredText. (As of this writing, getting VS Code to work with rst isn't a smooth experience).

Increasingly, tools are supporting markdown, so let's take the plunge and update the two .rst files in this repo to .md

Refs:
@miketheman miketheman added enhancement New feature or request documentation Improvements or additions to documentation labels Mar 30, 2021
miketheman added a commit that referenced this issue Mar 30, 2021
@miketheman
chore: replace rst with markdown
9c77739 
As tooling improves for Markdown, and it becomes a ubiquitous
syntax, convert our documentation over to that format.

Includes minor changes to content, such as ordering and formatting.

Resolves #59

Signed-off-by: Mike Fiedler <[email protected]>
@miketheman miketheman mentioned this issue Mar 30, 2021
Merged
@miketheman miketheman self-assigned this Mar 30, 2021
miketheman added a commit that referenced this issue Mar 30, 2021
@miketheman
chore: replace rst with markdown
8815be2 
As tooling improves for Markdown, and it becomes a ubiquitous
syntax, convert our documentation over to that format.

Includes minor changes to content, such as ordering and formatting.

Resolves #59

Signed-off-by: Mike Fiedler <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@miketheman miketheman

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: replace rst with markdown miketheman/pytest-socket
1 participant
@miketheman