search

STAR-RG / practical_testing_book

https://damorimrg.github.io/practical_testing_book/
16 stars 13 forks source link

Non-consecutive header level #13

Closed ViniciusSiqueira54 closed 4 years ago

ViniciusSiqueira54 commented 4 years ago

Descrição: Vários dos capítulos de nosso livro estão com a tabulação dos headers escrita erradas, pulando os leveis. Exemplos:

[...]
/home/siqueira/practical_testing_book/testgeneration/combinatorial.ipynb:10041: WARNING: Non-consecutive header level increase; 1 to 3
/home/siqueira/practical_testing_book/testgeneration/combinatorial.ipynb:10055: WARNING: Non-consecutive header level increase; 1 to 3
/home/siqueira/practical_testing_book/testgeneration/combinatorial.ipynb:160004: WARNING: Non-consecutive header level increase; 1 to 3
/home/siqueira/practical_testing_book/testgeneration/propertybased.ipynb:10008: WARNING: Non-consecutive header level increase; 1 to 3
/home/siqueira/practical_testing_book/testgeneration/propertybased.ipynb:10014: WARNING: Non-consecutive header level increase; 1 to 3
/home/siqueira/practical_testing_book/testgeneration/propertybased.ipynb:10019: WARNING: Non-consecutive header level increase; 1 to 3
/home/siqueira/practical_testing_book/testgeneration/propertybased.ipynb:180002: WARNING: Non-consecutive header level increase; 1 to 3
/home/siqueira/practical_testing_book/testgranularity/integrationtesting.md:12: WARNING: Non-consecutive header level increase; 1 to 3
/home/siqueira/practical_testing_book/testgranularity/integrationtesting.md:16: WARNING: Non-consecutive header level increase; 1 to 3
/home/siqueira/practical_testing_book/testgranularity/mocking.ipynb:20002: WARNING: Non-consecutive header level increase; 1 to 3
/home/siqueira/practical_testing_book/testregression/buildsystems.md:1: WARNING: Non-consecutive header level increase; 0 to 2
/home/siqueira/practical_testing_book/testregression/continuousintegration.md:1: WARNING: Non-consecutive header level increase; 0 to 4
/home/siqueira/practical_testing_book/testregression/continuousintegration.md:5: WARNING: Non-consecutive header level increase; 4 to 6
/home/siqueira/practical_testing_book/testregression/continuousintegration.md:9: WARNING: Non-consecutive header level increase; 4 to 6
/home/siqueira/practical_testing_book/testregression/continuousintegration.md:14: WARNING: Non-consecutive header level increase; 4 to 6
/home/siqueira/practical_testing_book/testregression/flakytests.md:1: WARNING: Non-consecutive header level increase; 0 to 4
/home/siqueira/practical_testing_book/testregression/gradlesetup.md:1: WARNING: Non-consecutive header level increase; 0 to 2
/home/siqueira/practical_testing_book/testregression/selectionprio.md:1: WARNING: Non-consecutive header level increase; 0 to 4
/home/siqueira/practical_testing_book/testregression/selectionprio.md:5: WARNING: Non-consecutive header level increase; 4 to 6
/home/siqueira/practical_testing_book/testregression/selectionprio.md:20: WARNING: Non-consecutive header level increase; 4 to 6
/home/siqueira/practical_testing_book/testregression/selectionprio.md:33: WARNING: Non-consecutive header level increase; 4 to 6
/home/siqueira/practical_testing_book/testregression/selectionprio.md:76: WARNING: Non-consecutive header level increase; 4 to 6
[...]

Resultado atual: Vários WARNINGs estão sendo disparados devido a esses erros de estrutura

Resultado esperado: WARNINGs relacionados a estrutura do livro não deveriam ser trigados

ViniciusSiqueira54 commented 4 years ago

Solução: Revisei todos esses arquivos que estavam com esse problema, como dica futura ao escrever novos capítulos usar a seguinte estrutura:

Titulo do capítulo
================
ou 
# Titulo do capítulo

## Seção 1
### Sub 1.1
#### Sub 1.2
##### Sub 1.3

## Seção 2
### Sub 2.1

## Seção 3

## Seção 4

[...]

https://jupyterbook.org/customize/toc.html#how-toc-yml-structure-maps-to-book-structure

ViniciusSiqueira54 commented 4 years ago

Commit com o fix.