From 904276190c17ca9559cc56bc7adf914317e106fa Mon Sep 17 00:00:00 2001 From: Tim Gates Date: Tue, 6 Sep 2022 17:24:01 +1000 Subject: [PATCH] docs: Fix a few typos There are small typos in: - CONTRIBUTING.md - docs/forms.md Fixes: - Should read `significant` rather than `signigicant`. - Should read `responsibility` rather than `responsobility`. - Should read `hardcoded` rather than `hardcodded`. - Should read `extract` rather than `exctract`. Signed-off-by: Tim Gates --- CONTRIBUTING.md | 4 ++-- docs/forms.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8be0b584..f6908bf1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -151,7 +151,7 @@ Rendered documentation will be available under: - Avoid mocking of external libraries; Mocking allowed only in tests. - Avoid complex structures, for complex classes/methods/functions try to separate to little objects, to simplify code reuse and testing. -- Avoid code duplications, try to exctract duplicate code to function. (Code +- Avoid code duplications, try to extract duplicate code to function. (Code duplication in tests is allowed.) - Write docstrings for new classes and methods. - Write tests and make sure they pass. @@ -159,7 +159,7 @@ Rendered documentation will be available under: ### Code style guide -- Docstrings are using RST format. Developer encouraged to include any signigicant +- Docstrings are using RST format. Developer encouraged to include any significant information to docstrings. - Developers are encouraged to include typing information in functions signatures. - Developers should avoid including typing information to docstrings, if possible. diff --git a/docs/forms.md b/docs/forms.md index e0b5eb30..3c39f8b7 100644 --- a/docs/forms.md +++ b/docs/forms.md @@ -108,7 +108,7 @@ allowing `None` values, i.e. {attr}`null=True`, then, when nothing selected in dropdown, the field will be created with `None` value. ```{important} -It is responsobility of developer, to correctly setup database field definition and +It is responsibility of developer, to correctly setup database field definition and make proper tests before own application release. BooleanField can create unexpected application behavior in if checks. Developer, should recheck all if checks like: @@ -447,7 +447,7 @@ any form+database behaviour. #### DictField with default empty dict value -Will place `{}` to form for existing/new fields. This value is hardcodded in parent +Will place `{}` to form for existing/new fields. This value is hardcoded in parent MongoEngine project. ```python