Re: [BuildStream] Updated CONTRIBUTING.rst guide

[Tristan Van Berkom <tristan vanberkom codethink co uk>]

On Mon, 2018-10-08 at 19:49 +0900, Tristan Van Berkom wrote:
> Hi again again.

Hi again again again :)

Today in transit I have enhanced the section of the contributing guide
which pertains to writing free form `.rst` files in the user guide
documentation, which had remained unmodified in my recent changes (I
realized that this was underspecified whilst reviewing some
documentation last week).

Cheers,
    -Tristan

> On Mon, 2018-10-08 at 18:13 +0900, Tristan Van Berkom via
> BuildStream-
> list wrote:
> > Hi again,
>
> [...]
> > [...]
> >
> > Minor update since this was updated on Saturday.
> >
> > In case you have already read through this, asides from some
> > grammatical errors and typo fixes, I have since added two new
> > entries
> > to the coding guidelines:
> >
> >   * File naming convention
> >
> >   * Minimize API surfaces
>
> Updated PEP-8 coding style section one more time to add a
> clarification
> about the linter settings for allowing 120 character length lines.
>
> This setting exists to handle exceptionally long lines without
> forcing
> us to write sometimes unreadable code in order to work around a
> strict
> linter. It is not an invitation to write code, comments, or
> docstrings
> which fill up the 120 character limit as much as possible.
>
> Cheers,
>     -Tristan