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

docs: fix typos #147

Merged
merged 1 commit into from
Jan 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Bug Fixes
- Add pyproject.toml support for config \(Issue \#10\) [\#77](https://github.com/PyCQA/docformatter/pull/77) ([weibullguy](https://github.com/weibullguy))
- Bugfix --wrap-summaries 0 now fully disables summary wrapping [\#74](https://github.com/PyCQA/docformatter/pull/74) ([howeaj](https://github.com/howeaj))
- Better document --docstring-length option and add it to the readme [\#72](https://github.com/PyCQA/docformatter/pull/72) ([AntoineD](https://github.com/AntoineD))
- Removed the empty line between function definiton and docstring \#51 [\#53](https://github.com/PyCQA/docformatter/pull/53) ([dabauxi](https://github.com/dabauxi))
- Removed the empty line between function definition and docstring \#51 [\#53](https://github.com/PyCQA/docformatter/pull/53) ([dabauxi](https://github.com/dabauxi))
- Pre-Summary Space Option [\#46](https://github.com/PyCQA/docformatter/pull/46) ([alecmerdler](https://github.com/alecmerdler))

## [v1.4](https://github.com/PyCQA/docformatter/tree/v1.4) (2020-12-27)
Expand Down
2 changes: 1 addition & 1 deletion docs/source/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ the requirement falls in, the type of requirement, and whether
' docformatter_11.8',' Should read docstrings from stdin and report results to stdout.', ' Stakeholder', ' Should', ' Yes [*PR #8*]'

Requirement ID's that begin with PEP_257 are taken from PEP 257. Those
prefaced with docformatter are un-releated to PEP 257.
prefaced with docformatter are un-related to PEP 257.

Test Suite
----------
Expand Down
2 changes: 1 addition & 1 deletion src/docformatter/encode.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ def do_detect_encoding(self, filename: str) -> None:
def do_find_newline(self, source: str) -> Dict[int, int]:
"""Return type of newline used in source.

Paramaters
Parameters
----------
source : list
A list of lines.
Expand Down
2 changes: 1 addition & 1 deletion tests/test_encoding_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ class TestDetectEncoding:
def test_detect_encoding_with_explicit_utf_8(
self, temporary_file, contents
):
"""Return utf-8 when explicitely set in file."""
"""Return utf-8 when explicitly set in file."""
uut = Encoder()
uut.do_detect_encoding(temporary_file)

Expand Down
2 changes: 1 addition & 1 deletion tests/test_format_docstring.py
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ def test_format_docstring_with_multi_paragraph_description(
test_args,
args,
):
"""Wrap each paragraph in the long description seperately.
"""Wrap each paragraph in the long description separately.

See issue #127.
"""
Expand Down