Skip to content

[IMP] readme template: subsection instructions #460

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

Open
dreispt wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[IMP] readme template: subsection instructions #460

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions template/module/readme/DESCRIPTION.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
This module extends the functionality of ... to support ...
and to allow you to ...

Fragments may contain section titles. The first title level must be underlined
with the ``~`` (tilde) character. Subsections can be underlined using any
non-alphanumeric character, other than ``~``, ``=`` and ``-``.
Copy link
Member

@pedrobaeza pedrobaeza Jun 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Examples of these allowed non-alphanumeric characters?