New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Recommend an introduction before H2 #10

Open

benoitbryon opened this issue May 7, 2012 · 0 comments

Labels

Owner

benoitbryon commented May 7, 2012

See https://github.com/benoitbryon/documentation-best-practices/issues/3

In RST documents, if you use H2 just after H1 like this...

##########
Some title
##########


********
Subtitle
********

Here some text.

... then it means that there is no introduction text.

Should be:

##########
Some title
##########

This document illustrates usage of introduction text.


********
Subtitle
********

Here some text.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment