Adiciona sumário à doc de utilitários (#90)

brazilian-utils · May 13, 2023 · e2e0028 · e2e0028
1 parent 5781a91
commit e2e0028
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -34,7 +34,20 @@ False
 
 # Utilitários
 
-## is_valid_cpf
+- [CPF](#cpf)
+  - [is_valid_cpf](#is_valid_cpf)
+  - [format_cpf](#format_cpf)
+  - [parse_cpf](#parse_cpf)
+  - [generate_cpf](#generate_cpf)
+- [CNPJ](#cnpj)
+  - [is_valid_cnpj](#is_valid_cnpj)
+  - [format_cnpj](#format_cnpj)
+  - [parse_cnpj](#parse_cnpj)
+  - [generate_cnpj](#generate_cnpj)
+
+## CPF
+
+### is_valid_cpf
 
 Verifica se o CPF é valido.
 
@@ -44,7 +57,7 @@ Verifica se o CPF é valido.
 False
 ```
 
-## format_cpf
+### format_cpf
 
 Formata o CPF. Retorna None se o CPF for inválido.
 
@@ -54,17 +67,16 @@ Formata o CPF. Retorna None se o CPF for inválido.
 '111.444.777-35'
 ```
 
-## parse_cpf
+### parse_cpf
 
 Remove os símbolos de formatação do CPF e retorna somente números. Filtra apenas os símbolos utilizados para a validação do CPF. Propositalmente não remove outros símbolos.
 
-
 ```python
 >>> from brutils import parse_cpf
 >>> parse_cpf('000.111.222-33')
 '00011122233'
 ```
-## generate_cpf
+### generate_cpf
 
 Gera um CPF válido aleatório.
 
@@ -74,7 +86,9 @@ Gera um CPF válido aleatório.
 '17433964657'
 ```
 
-## is_valid_cnpj
+## CNPJ
+
+### is_valid_cnpj
 
 Verifica se o CNPJ é valido. Apenas números, formatados como string.
 
@@ -84,7 +98,7 @@ Verifica se o CNPJ é valido. Apenas números, formatados como string.
 False
 ```
 
-## format_cnpj
+### format_cnpj
 
 Formata o CNPJ.
 
@@ -94,7 +108,7 @@ Formata o CNPJ.
 '00.111.222/0001-00'
 ```
 
-## parse_cnpj
+### parse_cnpj
 
 Remove os símbolos de formatação do CPF e retorna somente números. Filtra apenas os símbolos utilizados para a validação do CPF. Propositalmente não remove outros símbolos.
 
@@ -104,7 +118,7 @@ Remove os símbolos de formatação do CPF e retorna somente números. Filtra ap
 '00111222000100'
 ```
 
-## generate_cnpj
+### generate_cnpj
 
 Gera um CNPJ válido aleatório.
 

diff --git a/README_EN.md b/README_EN.md
@@ -34,7 +34,20 @@ False
 
 # Utilities
 
-## is_valid_cpf
+- [CPF](#cpf)
+  - [is_valid_cpf](#is_valid_cpf)
+  - [format_cpf](#format_cpf)
+  - [parse_cpf](#parse_cpf)
+  - [generate_cpf](#generate_cpf)
+- [CNPJ](#cnpj)
+  - [is_valid_cnpj](#is_valid_cnpj)
+  - [format_cnpj](#format_cnpj)
+  - [parse_cnpj](#parse_cnpj)
+  - [generate_cnpj](#generate_cnpj)
+
+## CPF
+
+### is_valid_cpf
 
 Check if CPF is valid.
 
@@ -44,7 +57,7 @@ Check if CPF is valid.
 False
 ```
 
-## format_cpf
+### format_cpf
 
 Format CPF. Returns None if CPF is invalid.
 
@@ -54,7 +67,7 @@ Format CPF. Returns None if CPF is invalid.
 '111.444.777-35'
 ```
 
-## parse_cpf
+### parse_cpf
 
 Remove formatting symbols from CPF and return only digits.
 It only filters out the symbols used for CPF validation.
@@ -65,7 +78,8 @@ It purposefully doesn't remove other symbols.
 >>> parse_cpf('000.111.222-33')
 '00011122233'
 ```
-## generate_cpf
+
+### generate_cpf
 
 Generate a valid random CPF.
 
@@ -75,7 +89,9 @@ Generate a valid random CPF.
 '17433964657'
 ```
 
-## is_valid_cnpj
+## CNPJ
+
+### is_valid_cnpj
 
 Check if CNPJ is valid. Numbers only, formatted as strings.
 
@@ -85,7 +101,7 @@ Check if CNPJ is valid. Numbers only, formatted as strings.
 False
 ```
 
-## format_cnpj
+### format_cnpj
 
 Format CNPJ.
 
@@ -95,7 +111,7 @@ Format CNPJ.
 '00.111.222/0001-00'
 ```
 
-## parse_cnpj
+### parse_cnpj
 
 Remove formatting symbols from CNPJ and return only digits.
 It only filters out the symbols used for CNPJ validation.
@@ -107,7 +123,7 @@ It purposefully doesn't remove other symbols.
 '00111222000100'
 ```
 
-## generate_cnpj
+### generate_cnpj
 
 Generate a valid random CNPJ.