libcloud-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Kami <...@git.apache.org>
Subject [GitHub] libcloud pull request: [WIP] Treat sphinx warnings as errors
Date Wed, 30 Dec 2015 08:18:01 GMT
GitHub user Kami opened a pull request:

    https://github.com/apache/libcloud/pull/669

    [WIP] Treat sphinx warnings as errors

    This pull request re-enabled features which treats sphinx warnings as errors which cause
build to fail.
    
    We had this feature enabled in the past, but at some point we disabled it (probably when
we enabled sphinx auto doc) so we accumulated a bunch of documentation and docstring related
debts since warnings didn't cause build to fail and people simply ignored those issues.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/Kami/libcloud sphinx_docstring_fixes

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/libcloud/pull/669.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #669
    
----
commit bed9fb67875fec60ab829d3d23ad14c5a7069762
Author: Tomaz Muraus <tomaz@tomaz.me>
Date:   2015-12-30T07:29:03Z

    Fix docstring issues causing sphinx warnings.

commit 68b6c2d5d8553ead2ad278d0ce16d794c4a3776c
Author: Tomaz Muraus <tomaz@tomaz.me>
Date:   2015-12-30T07:49:06Z

    Try a hack to avoid warnings from docstrings.
    
    For now, we just want to treat, non-docstring related warnings as errors.

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message