Skip to content

Commit 9167fc0

Browse files
committed
Clarify naming conventions
1 parent 78dd631 commit 9167fc0

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ The URL Pattern Standard is a web standard for URL pattern matching. It is usefu
1313

1414
It's a thin wrapper of [denoland/rust-urlpattern](https://github.com/denoland/rust-urlpattern) with [PyO3](https://github.com/PyO3/pyo3) + [Maturin](https://github.com/PyO3/maturin).
1515

16-
The naming conventions follow [the standard](https://urlpattern.spec.whatwg.org/) as closely as possible, similar to [xml.dom](https://docs.python.org/3/library/xml.dom.html).
17-
1816
## Installation
1917

2018
On Linux/UNIX or macOS:
@@ -128,6 +126,6 @@ Check `pytest.skip` in [`tests/test_lib.py`](https://github.com/urlpattern/pytho
128126

129127
## Why camelCase?
130128

131-
In this library, some names such as `baseURL` and `hasRegExpGroups` do not use snake_case.
129+
As seen in names like `baseURL` and `hasRegExpGroups`, this library does not follow Python's [PEP 8 naming conventions](https://peps.python.org/pep-0008/#function-and-variable-names). Instead, it follows [the standard](https://urlpattern.spec.whatwg.org/) naming as closely as possible.
132130

133-
Like [`xml.dom`](https://docs.python.org/3/library/xml.dom.html), Python wrappers around web standards typically preserve the original camelCase rather than converting names to snake_case. This library follows that convention as well.
131+
Like [`xml.dom`](https://docs.python.org/3/library/xml.dom.html), Python wrappers around web standards typically preserve the original camelCase rather than converting names to snake_case, and this library follows that convention as well.

0 commit comments

Comments
 (0)