From 58f217c81c32c437051519d89111c3f94d63e063 Mon Sep 17 00:00:00 2001 From: prateek-dagar Date: Mon, 3 Aug 2026 23:41:18 +0530 Subject: [PATCH] Fix spelling errors in docs and core docstring --- docs/changelog.md | 2 +- docs/contributing.md | 6 +++--- src/pythonjsonlogger/core.py | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 4ea8000..b4299b6 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -24,7 +24,7 @@ Thanks @gaoflow ### Added - Support `DictConfigurator` prefixes for `rename_fields` and `static_fields`. [#45](https://github.com/nhairs/python-json-logger/pull/45) - Allows using values like `ext://sys.stderr` in `fileConfig`/`dictConfig` value fields. -- Support comma seperated lists for Formatter `fmt` (`style=","`) e.g. `"asctime,message,levelname"` [#15](https://github.com/nhairs/python-json-logger/issues/15) +- Support comma separated lists for Formatter `fmt` (`style=","`) e.g. `"asctime,message,levelname"` [#15](https://github.com/nhairs/python-json-logger/issues/15) - Note that this style is specific to `python-json-logger` and thus care should be taken not to pass this format to other logging Formatter implementations. - Supports sequences of strings (e.g. lists and tuples) of field names for Formatter `fmt`. [#16](https://github.com/nhairs/python-json-logger/issues/16) diff --git a/docs/contributing.md b/docs/contributing.md index aff0ca9..e06999e 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -114,17 +114,17 @@ For examples of how to support a third-party encoder see `orjson.py` and `msgspe The following encoders have been considered and rejected: - [simplejson](https://github.com/simplejson/simplejson) - as of 2026-03-29 is ranked ~370 with ~55M downloads / month. Due to errors when handling `bytes` objects and lack of interest from the community ([see comment for more details](https://github.com/nhairs/python-json-logger/pull/64#issuecomment-4149326316)). -- [ultrajson](https://github.com/ultrajson/ultrajson) (`usjon`) - as of 2026-03-29 is ranked ~630 with ~27 downloads / month. Due to errors when handling `bytes` objects and lack of interest from the community ([see comment for more details](https://github.com/nhairs/python-json-logger/pull/64#issuecomment-4149326316)). Additionally it is in maintence mode. +- [ultrajson](https://github.com/ultrajson/ultrajson) (`usjon`) - as of 2026-03-29 is ranked ~630 with ~27 downloads / month. Due to errors when handling `bytes` objects and lack of interest from the community ([see comment for more details](https://github.com/nhairs/python-json-logger/pull/64#issuecomment-4149326316)). Additionally it is in maintenance mode. - [python-rapidjson](https://github.com/python-rapidjson/python-rapidjson) - as of 2026-03-22 is ranked ~1800 with ~4.5M downloads / month. - [pysimdjson](https://github.com/TkTech/pysimdjson) - as of 2026-03-22 is ranked ~4200 with >1M downloads / month. - [yapic.json](https://github.com/zozzz/yapic.json) - as of 2026-03-22 is not in top 15K packages. - [cysimdjson](https://github.com/TeskaLabs/cysimdjson) - as of 2026-03-22 is not in top 15K packages. -### Versioning and breaking compatability +### Versioning and breaking compatibility This project uses semantic versioning. -In general backwards compatability is always preferred. This library is widely used and not particularly sophisticated and as such there must be a good reason for breaking changes. +In general backwards compatibility is always preferred. This library is widely used and not particularly sophisticated and as such there must be a good reason for breaking changes. Feature changes MUST be compatible with all [security supported versions of Python](https://endoflife.date/python) and SHOULD be compatible with all unsupported versions of Python where [recent downloads over the last 90 days exceeds 5% of all downloads](https://pypistats.org/packages/python-json-logger). diff --git a/src/pythonjsonlogger/core.py b/src/pythonjsonlogger/core.py index 7217afb..8807aed 100644 --- a/src/pythonjsonlogger/core.py +++ b/src/pythonjsonlogger/core.py @@ -174,7 +174,7 @@ def __init__( *Added in 4.0*: - - `fmt` now supports comma seperated lists (`style=","`). Note that this style is specific + - `fmt` now supports comma separated lists (`style=","`). Note that this style is specific to `python-json-logger` and thus care should be taken to not to pass this format to other logging Formatter implementations. - `fmt` now supports sequences of strings (e.g. lists and tuples) of field names.