JakeHillion/drgn
1
0
Fork 0
mirror of https://github.com/JakeHillion/drgn.git synced 2024-12-21 08:47:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING: fix nested list syntax

Browse Source 
Extra new lines are required around the nested list.

Signed-off-by: Omar Sandoval <osandov@osandov.com>
This commit is contained in:
Omar Sandoval 2024-01-04 14:27:20 -08:00
parent a7f9db3067
commit e6fb8f14d4
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.rst
View File

@ -93,14 +93,17 @@ some slightly more modern preferences:
* Variables should be declared as close as possible to where they are used (as
opposed to the C89 style of declaring everything at the top of a function).
* As an exception, if a function has a local ``struct drgn_error *err``, it
should usually be declared at the top of the function. (This is because
must functions have such a variable, and it adds noise to have it in the
middle of the function.)
* Scope guards and the `cleanup attribute
<https://gcc.gnu.org/onlinedocs/gcc/Common-Variable-Attributes.html#index-cleanup-variable-attribute>`_
should be used liberally.
* ``//``-style comments are preferred over ``/* */``.
* As an exception, Doxygen comments should use ``/** */``.
For example: