Skip to content

Commit

Permalink
docs: Fix headers in contributing guide
Browse files Browse the repository at this point in the history
RST has stricter rules about headers than markdown.
  • Loading branch information
riddell-stan committed Jul 8, 2020
1 parent ecd0dcd commit d61ef86
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Contributing to PyStan
======================

Introduction
------------
============

PyStan is a Python interface to C++ functions in the `Stan library`_.
Specifically, PyStan provides an interface to the C++ functions in the ``stan::services`` namespace.
Expand All @@ -24,7 +24,7 @@ Contract (C4)`_.
.. _Collective Code Construction Contract (C4): https://rfc.zeromq.org/spec:42/C4/

Coding Style
------------
============

PyStan code is `PEP 8`_ compliant. The project uses the code formatter black_ with a maximum
line-length of 119 characters. Documentation, comments, and docstrings should be wrapped at 79 characters, even though PEP 8 suggests 72.
Expand All @@ -35,7 +35,7 @@ line-length of 119 characters. Documentation, comments, and docstrings should be
PyStan code is also checked by ``flake8`` and ``mypy``.

Commit Messages
---------------
===============

git commit messages must be formatted carefully in order to allow the automatic generation of release notes.

Expand Down

0 comments on commit d61ef86

Please sign in to comment.