Skip to content

Commit e92ea2f

Browse files
author
Rafael Henter
committed
Fix documentation typos
1 parent 71b777f commit e92ea2f

6 files changed

Lines changed: 40 additions & 42 deletions

File tree

README.pt.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Django Models é uma biblioteca com vários Modelos úteis para Django para ajud
99
Requirements
1010
============
1111

12-
- Python 3.x
12+
- Python 3.8 ou mais novo
1313
- Django 1.11 ou mais novo
1414

1515
Features
@@ -24,18 +24,18 @@ Generic Models
2424

2525
- CodeModel
2626

27-
Modelo com um campo code que gera automaticamente um hash de 16 caracteres por padrão. Muito util para identificar seu registro de forma mais humanizada
27+
Modelo com um campo code que gera automaticamente um hash de 16 caracteres por padrão. Muito útil para identificar seu registro de forma mais humanizada
2828

2929
History models
3030
--------------
3131

3232
- HistoryModel
3333

34-
Modelo que permite rastrear cada alteração feita na instância ao salvar para gerar um Historico de modificações da instância
34+
Modelo que permite rastrear cada alteração feita na instância ao salvar para gerar um Histórico de modificações da instância
3535

3636
- SerializerModel
3737

38-
Modelo com o metodo serialize que retorna um dict com todas as informações da instância sem precisar de um serializador configurado.
38+
Modelo com o método serialize que retorna um dict com todas as informações da instância sem precisar de um serializador configurado.
3939

4040
.. code-block:: python
4141
@@ -57,15 +57,15 @@ History models
5757
5858
- SlugModel
5959

60-
Modelo com um campo slug. util para se usar em urls ou referencias nominais
60+
Modelo com um campo slug. Útil para se usar em urls ou referências nominais
6161

6262
- TimestampedModel
6363

64-
Modelo com os campos Datetime, created_at and updated_at. Uteis para controlar quando uma instancia foi criada ou aterada.
64+
Modelo com os campos Datetime, created_at and updated_at. Úteis para controlar quando uma instância foi criada ou alterada.
6565

6666
- UUIDModel
6767

68-
Modelo que usa o campo id como um UUID. Util para poder ter um identificador único sem se preocupar com sequenciais.
68+
Modelo que usa o campo id como um UUID. Útil para poder ter um identificador único sem se preocupar com sequenciais.
6969

7070

7171
Signals Models
@@ -83,7 +83,7 @@ Quando Apagar:
8383
- pre_delete (Antes de Apagar)
8484
- post_delete (Depois de Apagar)
8585

86-
Examplo usando o signal Pre-save
86+
Exemplo usando o signal Pre-save
8787

8888
.. code-block:: python
8989
@@ -101,13 +101,13 @@ Soft Delete Signal Model
101101

102102
- SoftDeleteSignalModel Models
103103

104-
É o SignalsModel com soft delete implementado. Permite que nada que você apague seja realmente apagado do sistema e de facil recuperação
104+
É o SignalsModel com soft delete implementado. Permite que nada que você apague seja realmente apagado do sistema e de fácil recuperação
105105

106106

107107
Como Instalar
108108
=============
109109

110-
Vamos la!
110+
Vamos !
111111
---------
112112

113113
Você pode instalar o Django Models usando pip:
@@ -117,7 +117,7 @@ Você pode instalar o Django Models usando pip:
117117
$ pip install django-models
118118
119119
120-
Se preferir instalar usando o codigo, pegue o endereço do repositorio git do GitHub e rode o setup.py
120+
Se preferir instalar usando o código, pegue o endereço do repositório git do GitHub e rode o setup.py
121121

122122
.. code:: shell
123123
@@ -146,15 +146,15 @@ Para habilitar o `django_models` no seu projeto você precisa adiciona-lo ao `IN
146146
Documentação
147147
============
148148

149-
Confira a ultima versão da documento do ``django-models`` em `GitHub Pages <https://rhenter.github.io/django-models/>`_
149+
Confira a última versão da documentação do ``django-models`` em `GitHub Pages <https://rhenter.github.io/django-models/>`_
150150

151151
Contribuição
152152
============
153153

154154
Por favor envie pull requests, são muito apreciados.
155155

156156

157-
1. Faço o Fork do repositorio `repository <https://github.com/rhenter/django_models>`_ no GitHub.
157+
1. Faça o Fork do repositório `repository <https://github.com/rhenter/django_models>`_ no GitHub.
158158
2. Crie uma branch fora da master e commit as suas modificações.
159159
3. Instale as dependências. ``pip install -r requirements-dev.txt``
160160
4. Instale o pre-commit. ``pre-commit install``

README.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ Django Models
66

77
|PyPI latest| |PyPI Version| |PyPI License| |GitHub Actions Status| |Coverage| |Docs| |Open Source? Yes!|
88

9-
Django Models is Library with several useful Models for Django to help you make your templates smart or with less code
9+
Django Models is a Library with several useful Models for Django to help you make your templates smart or with less code
1010

1111
Requirements
1212
============
1313

14-
- Python 3.x
14+
- Python 3.8 or later
1515
- Django 1.11 or later
1616

1717
Features
@@ -70,20 +70,20 @@ Example:
7070
History models
7171
--------------
7272

73-
- History Model
74-
Model that track each save to generate a History Changes of a record
73+
- HistoryModel
74+
Model that tracks each save to generate a Change History of a record
7575

7676
Signals Models
7777
--------------
7878

79-
With SignalModel it allows you to handle or execute an event according to Django's Signals.
79+
With SignalsModel it allows you to handle or execute an event according to Django's Signals.
8080

8181
On Save:
8282
- pre_save (Before Saving)
83-
- post_save (After saving)
83+
- post_save (After Saving)
8484

85-
On Erase:
86-
- pre_delete (Before Erasing)
85+
On Delete:
86+
- pre_delete (Before Deleting)
8787
- post_delete (After Deleting)
8888

8989
Example using Pre-save signal
@@ -105,7 +105,7 @@ Soft Delete Signal Model
105105

106106
- SoftDeleteSignalModel Models
107107

108-
It is the SignalsModel with soft delete implemented. Allows nothing you delete to be really deleted from the system and easy to recover
108+
It is the SignalsModel with soft delete implemented. Ensures that nothing you delete is really deleted from the system and easy to recover
109109

110110

111111
How to install

docs/en/_sources/features.rst.txt

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ Example:
1212

1313
.. code-block:: python
1414
15-
from django_models.models import SignalsModel
15+
from django_models.models import SerializerModel
1616
...
1717
18-
class YourModel(SignalsModel)
18+
class YourModel(SerializerModel)
1919
name = models.CharField(max_length=255)
2020
...
2121
@@ -45,19 +45,19 @@ History Model
4545

4646
- History models
4747

48-
Model that track each save to generate a History Changes of a record
48+
Model that tracks each save to generate a Change History of a record
4949

5050
Signals Models
5151
~~~~~~~~~~~~~~
5252

53-
With SignalModel it allows you to handle or execute an event according to Django's Signals.
53+
With SignalsModel it allows you to handle or execute an event according to Django's Signals.
5454

5555
On Save:
5656
- pre_save (Before Saving)
57-
- post_save (After saving)
57+
- post_save (After Saving)
5858

59-
On Erase:
60-
- pre_delete (Before Erasing)
59+
On Delete:
60+
- pre_delete (Before Deleting)
6161
- post_delete (After Deleting)
6262

6363
Example using Pre-save signal
@@ -78,5 +78,4 @@ Note: This will be made before you save your model
7878
Soft Delete Signal Model
7979
~~~~~~~~~~~~~~~~~~~~~~~~
8080

81-
It is the SignalsModel with soft delete implemented. Allows nothing you delete to be really deleted from the system and easy to recover
82-
81+
It is the SignalsModel with soft delete implemented. Ensures that nothing you delete is really deleted from the system and easy to recover

docs/en/_sources/index.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Welcome to Django Models's documentation!
22
=========================================
33

4-
Django Models is Library with several useful Models for Django to help you make your templates smart or with less code
4+
Django Models is a Library with several useful Models for Django to help you make your templates smart or with less code
55

66
Features
77
--------

docs/pt-br/_sources/features.rst.txt

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ Example:
1212

1313
.. code-block:: python
1414
15-
from django_models.models import SignalsModel
15+
from django_models.models import SerializerModel
1616
...
1717
18-
class YourModel(SignalsModel)
18+
class YourModel(SerializerModel)
1919
name = models.CharField(max_length=255)
2020
...
2121
@@ -45,19 +45,19 @@ History Model
4545

4646
- History models
4747

48-
Model that track each save to generate a History Changes of a record
48+
Model that tracks each save to generate a Change History of a record
4949

5050
Signals Models
5151
~~~~~~~~~~~~~~
5252

53-
With SignalModel it allows you to handle or execute an event according to Django's Signals.
53+
With SignalsModel it allows you to handle or execute an event according to Django's Signals.
5454

5555
On Save:
5656
- pre_save (Before Saving)
57-
- post_save (After saving)
57+
- post_save (After Saving)
5858

59-
On Erase:
60-
- pre_delete (Before Erasing)
59+
On Delete:
60+
- pre_delete (Before Deleting)
6161
- post_delete (After Deleting)
6262

6363
Example using Pre-save signal
@@ -78,5 +78,4 @@ Note: This will be made before you save your model
7878
Soft Delete Signal Model
7979
~~~~~~~~~~~~~~~~~~~~~~~~
8080

81-
It is the SignalsModel with soft delete implemented. Allows nothing you delete to be really deleted from the system and easy to recover
82-
81+
It is the SignalsModel with soft delete implemented. Ensures that nothing you delete is really deleted from the system and easy to recover

docs/pt-br/_sources/index.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Welcome to Django Models's documentation!
22
=========================================
33

4-
Django Models is Library with several useful Models for Django to help you make your templates smart or with less code
4+
Django Models é uma biblioteca com vários Modelos úteis para Django para ajudá-lo a tornar seus templates inteligentes ou com menos código
55

66
Features
77
--------

0 commit comments

Comments
 (0)