Skip to content

Commit b05a1d8

Browse files
šŸŽ‰ New version of fordev package - v1.0.3
- Remoção da seção de opções de valores de um parâmetro das docstrings, estava quebrando o layout da documentação. - Transferido a seção de opções de valores para a documentação oficial.
2 parents 7aba721 + e093128 commit b05a1d8

File tree

3 files changed

+71
-22
lines changed

3 files changed

+71
-22
lines changed

ā€Ždocs/source/fordev/validators.rst

+62
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,69 @@ Docs de todas funƧƵes
3636
---------------------
3737

3838
.. autofunction:: fordev.validators.is_valid_credit_card
39+
40+
:Bandeiras suportadas:
41+
42+
``1`` = **MasterCard**
43+
44+
``2`` = **Visa 16 DĆ­gitos**
45+
46+
``3`` = **Visa Electron**
47+
48+
``4`` = **American Express**
49+
50+
``5`` = **Diners Club**
51+
52+
``6`` = **Discover**
53+
54+
``7`` = **enRoute**
55+
56+
``8`` = **JCB**
57+
58+
``9`` = **Maestro**
59+
60+
``10`` = **Solo**
61+
62+
``11`` = **Switch**
63+
64+
``12`` = **Laser**
65+
66+
.. note::
67+
68+
O valor númerico que representa a bandeira do cartão de crédito deve ser passada para o parâmetro ``flag``.
69+
70+
**Exemplo:**
71+
72+
.. code-block:: python
73+
74+
>>> from fordev.validators import is_valid_credit_card
75+
>>> is_valid_credit_card(flag=3) # Visa Electron
76+
3977
.. autofunction:: fordev.validators.is_valid_bank_account
78+
79+
:Bandeiras suportadas:
80+
81+
``1`` = **Banco do Brasil**
82+
83+
``2`` = **Bradesco**
84+
85+
``3`` = **Citibank**
86+
87+
``4`` = **ItaĆŗ**
88+
89+
``5`` = **Santander**
90+
91+
.. note::
92+
93+
O valor númerico que representa a bandeira do banco deve ser passada para o parâmetro ``bank``.
94+
95+
**Exemplo:**
96+
97+
.. code-block:: python
98+
99+
>>> from fordev.validators import is_valid_bank_account
100+
>>> is_valid_bank_account(bank=4) # ItaĆŗ
101+
40102
.. autofunction:: fordev.validators.is_valid_certificate
41103
.. autofunction:: fordev.validators.is_valid_cnh
42104
.. autofunction:: fordev.validators.is_valid_cnpj

ā€Žfordev/__about__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# -*- coding: utf-8 -*-
22
"""Metadados do projeto."""
33

4-
__version__ = '1.0.2'
4+
__version__ = '1.0.3'
55
__author__ = 'Matheus Felipe'
66
__email__ = '[email protected]'
77
__author_github__ = 'https://github.com/matheusfelipeog'

ā€Žfordev/validators.py

+8-21
Original file line numberDiff line numberDiff line change
@@ -115,19 +115,9 @@ def is_valid_credit_card(flag: int, credit_card_code: str, data_only: bool=True)
115115
----------
116116
flag
117117
A bandeira do cartão de crédito que deseja validar o código.
118-
OpƧƵes:
119-
1 = MasterCard
120-
2 = Visa 16 DĆ­gitos
121-
3 = Visa Electron
122-
4 = American Express
123-
5 = Diners Club
124-
6 = Discover
125-
7 = enRoute
126-
8 = JCB
127-
9 = Maestro
128-
10 = Solo
129-
11 = Switch
130-
12 = Laser
118+
119+
Consulte a doc para verificar as opƧƵes suportadas:
120+
https://fordev.rtfd.io/pt_BR/latest/fordev/generators.html
131121
132122
credit_card_code
133123
O código do cartão de crédito para verificação.
@@ -164,18 +154,15 @@ def is_valid_bank_account(bank: int, agency: str, account: str, data_only: bool=
164154
----------
165155
bank
166156
A bandeira do banco da conta bancƔria que deseja validar os dados.
167-
OpƧƵes:
168-
1 = Banco do Brasil
169-
2 = Bradesco
170-
3 = Citibank
171-
4 = ItaĆŗ
172-
5 = Santander
157+
158+
Consulte a doc para verificar as opƧƵes suportadas:
159+
https://fordev.rtfd.io/pt_BR/latest/fordev/generators.html
173160
174161
agency
175-
O código da agência bancÔria para verificação..
162+
O código da agência bancÔria para verificação.
176163
177164
account
178-
O código da conta bancÔria para verificação..
165+
O código da conta bancÔria para verificação.
179166
"""
180167

181168
# Check if bank code is invalid. If true, raise exception.

0 commit comments

Comments
Ā (0)