Skip to content

Commit d184e41

Browse files
Fix documentation typos and formatting (#352)
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
1 parent a2d010e commit d184e41

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Readme Renderer
2-
===============
2+
================
33

44
.. image:: https://badge.fury.io/py/readme-renderer.svg
55
:target: https://badge.fury.io/py/readme-renderer
@@ -33,4 +33,4 @@ chat rooms, and mailing lists is expected to follow the `PSF Code of Conduct`_.
3333
.. _twine check: https://packaging.python.org/guides/making-a-pypi-friendly-readme#validating-restructuredtext-markup
3434
.. _PSF Code of Conduct: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md
3535

36-
Copyright © 2014, [The Python Packaging Authority].
36+
Copyright © 2014, The Python Packaging Authority.

readme_renderer/markdown.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ def render(
9393
def _highlight(html: str) -> str:
9494
"""Syntax-highlights HTML-rendered Markdown.
9595
96-
Plucks sections to highlight that conform the the GitHub fenced code info
96+
Plucks sections to highlight that conform to the GitHub fenced code info
9797
string as defined at https://github.github.com/gfm/#info-string.
9898
9999
Args:

readme_renderer/rst.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ def emptytag(
7676

7777
# Output math blocks as LaTeX that can be interpreted by MathJax for
7878
# a prettier display of Math formulas.
79-
# Pass a dummy path to supress docutils warning and emit HTML.
79+
# Pass a dummy path to suppress docutils warning and emit HTML.
8080
"math_output": "MathJax /dummy.js",
8181

8282
# Disable raw html as enabling it is a security risk, we do not want

0 commit comments

Comments
 (0)