Skip to content

Commit 2b79776

Browse files
authored
docs: arruma a ordem dos utilitários do IBGE (#557)
1 parent bafef03 commit 2b79776

3 files changed

Lines changed: 50 additions & 50 deletions

File tree

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ False
6767
- [Email](#email)
6868
- [is\_valid\_email](#is_valid_email)
6969
- [Data](#date)
70-
- [convert\_date\_to_text](#convert_date_to_text)
70+
- [convert\_date\_to_text](#convert_date_to_text)
7171
- [Placa de Carro](#placa-de-carro)
7272
- [is\_valid\_license\_plate](#is_valid_license_plate)
7373
- [format\_license\_plate](#format_license_plate)
@@ -90,8 +90,8 @@ False
9090
- [format\_voter\_id](#format_voter_id)
9191
- [generate\_voter\_id](#generate_voter_id)
9292
- [IBGE](#ibge)
93-
- [get_code_by_municipality_name](#get_code_by_municipality_name)
9493
- [convert_code_to_uf](#convert_code_to_uf)
94+
- [get_code_by_municipality_name](#get_code_by_municipality_name)
9595
- [get\_municipality\_by\_code](#get_municipality_by_code)
9696
- [Feriados](#feriados)
9797
- [is_holiday](#is_holiday)
@@ -1146,25 +1146,6 @@ Exemplo:
11461146
>>>
11471147
```
11481148

1149-
### get_municipality_by_code
1150-
1151-
Retorna o nome do município e a UF para um código do IBGE.
1152-
1153-
Args:
1154-
* code (str): O código do IBGE para o município.
1155-
1156-
Returns:
1157-
* tuple: Retorna uma Tupla formatado como ("Município", "UF").
1158-
* None: Retorna None se o código for inválido.
1159-
1160-
Example:
1161-
1162-
```python
1163-
>>> from brutils import get_municipality_by_code
1164-
>>> get_municipality_by_code(3550308)
1165-
("São Paulo", "SP")
1166-
```
1167-
11681149
### get_code_by_municipality_name
11691150

11701151
Retorna o código IBGE para um dado nome de município e código de UF.
@@ -1196,6 +1177,25 @@ None
11961177
None
11971178
```
11981179

1180+
### get_municipality_by_code
1181+
1182+
Retorna o nome do município e a UF para um código do IBGE.
1183+
1184+
Args:
1185+
* code (str): O código do IBGE para o município.
1186+
1187+
Returns:
1188+
* tuple: Retorna uma Tupla formatado como ("Município", "UF").
1189+
* None: Retorna None se o código for inválido.
1190+
1191+
Example:
1192+
1193+
```python
1194+
>>> from brutils import get_municipality_by_code
1195+
>>> get_municipality_by_code(3550308)
1196+
("São Paulo", "SP")
1197+
```
1198+
11991199
## Feriados
12001200

12011201
### is_holiday
@@ -1234,7 +1234,7 @@ True
12341234
### format_currency
12351235

12361236
Formata um número seguindo o padrão monetário brasileiro. O número será formatado
1237-
adicionando o símbolo R$ como prefixo, vírgula como separador decimal, e ponto como
1237+
adicionando o símbolo R$ como prefixo, vírgula como separador decimal, e ponto como
12381238
agrupador de milhar.
12391239

12401240
Argumentos:
@@ -1328,4 +1328,4 @@ Vamos construir juntos! 🚀🚀
13281328
<img src="https://contrib.rocks/image?repo=brazilian-utils/brutils-python" />
13291329
</a></br></br>
13301330

1331-
_Feito por [contrib.rocks](https://contrib.rocks)._
1331+
_Feito por [contrib.rocks](https://contrib.rocks)._

README_EN.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ False
5959
- [get\_address\_from\_cep](#get_address_from_cep)
6060
- [get\_cep\_information\_from\_address](#get_cep_information_from_address)
6161
- [Date](#date)
62-
- [convert\_date\_to_text](#convert_date_to_text)
62+
- [convert\_date\_to_text](#convert_date_to_text)
6363
- [Phone](#phone)
6464
- [is\_valid\_phone](#is_valid_phone)
6565
- [format\_phone](#format_phone)
@@ -91,8 +91,8 @@ False
9191
- [generate_voter_id](#generate_voter_id)
9292
- [IBGE](#ibge)
9393
- [convert_code_to_uf](#convert_code_to_uf)
94-
- [get\_municipality\_by\_code](#get_municipality_by_code)
9594
- [get_code_by_municipality_name](#get_code_by_municipality_name)
95+
- [get\_municipality\_by\_code](#get_municipality_by_code)
9696
- [Holidays](#holidays)
9797
- [is_holiday](#is_holiday)
9898
- [Monetary](#monetary)
@@ -459,15 +459,15 @@ Example:
459459

460460
## Date
461461

462-
### convert_date_to_text
462+
### convert_date_to_text
463463
Convert a brazilian date (dd/mm/yyyy) format in their portuguese textual representation.
464464

465465
Args:
466466
- date (str): A date in a string format dd/mm/yyyy.
467467

468468
Return:
469469
- (str) | None: A portuguese textual representation of the date or None case a date is invalid.
470-
470+
471471

472472
Example:
473473

@@ -1147,25 +1147,6 @@ Exemplo:
11471147
>>>
11481148
```
11491149

1150-
### get_municipality_by_code
1151-
1152-
Returns the municipality name and UF for a given IBGE code.
1153-
1154-
Args:
1155-
* code (str): The IBGE code of the municipality.
1156-
1157-
Returns:
1158-
* tuple: Returns a tuple formatted as ("Município", "UF").
1159-
* None: Returns None if the code is not valid.
1160-
1161-
Example:
1162-
1163-
```python
1164-
>>> from brutils import get_municipality_by_code
1165-
>>> get_municipality_by_code(3550308)
1166-
("São Paulo", "SP")
1167-
```
1168-
11691150
### get_code_by_municipality_name
11701151

11711152
Returns the IBGE code for a given municipality name and uf code.
@@ -1200,6 +1181,25 @@ None
12001181
None
12011182
```
12021183

1184+
### get_municipality_by_code
1185+
1186+
Returns the municipality name and UF for a given IBGE code.
1187+
1188+
Args:
1189+
* code (str): The IBGE code of the municipality.
1190+
1191+
Returns:
1192+
* tuple: Returns a tuple formatted as ("Município", "UF").
1193+
* None: Returns None if the code is not valid.
1194+
1195+
Example:
1196+
1197+
```python
1198+
>>> from brutils import get_municipality_by_code
1199+
>>> get_municipality_by_code(3550308)
1200+
("São Paulo", "SP")
1201+
```
1202+
12031203
## Holidays
12041204

12051205
### is_holiday
@@ -1236,8 +1236,8 @@ True
12361236

12371237
### format_currency
12381238

1239-
Formats a number following the Brazilian monetary standard. The number will be
1240-
formatted by adding the R$ symbol as a prefix, a comma as a decimal separator, and a
1239+
Formats a number following the Brazilian monetary standard. The number will be
1240+
formatted by adding the R$ symbol as a prefix, a comma as a decimal separator, and a
12411241
period as a thousands grouper.
12421242

12431243
Args:
@@ -1333,4 +1333,4 @@ Let's build it together 🚀🚀
13331333
<img src="https://contrib.rocks/image?repo=brazilian-utils/brutils-python" />
13341334
</a></br></br>
13351335

1336-
_Made with [contrib.rocks](https://contrib.rocks)._
1336+
_Made with [contrib.rocks](https://contrib.rocks)._

brutils/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,8 @@
127127
"is_valid_voter_id",
128128
# IBGE
129129
"convert_code_to_uf",
130-
"get_municipality_by_code",
131130
"get_code_by_municipality_name",
131+
"get_municipality_by_code",
132132
# Date Utils
133133
"is_holiday",
134134
# Currency

0 commit comments

Comments
 (0)