Turn sphinx warnings into errors #178
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Oh, CI doesn't run. |
pirapira
commented
Jan 2, 2019
| @@ -841,8 +841,8 @@ Protocol Values Constraints | |||
| (3 R) Tk <= Tt, if time k < time t | |||
|
|
|||
| Channel deposits, channel withdraws, off-chain transferred amounts are all monotonically increasing. | |||
| The ``TokenNetwork`` contract must enforce this for deposits (`code here <https://github.com/raiden-network/raiden-contracts/blob/fc1c79329a165c738fc55c3505cf801cc79872e4/raiden_contracts/contracts/TokenNetwork.sol#L306-L308/>`_) and withdraws (`code here <https://github.com/raiden-network/raiden-contracts/blob/fc1c79329a165c738fc55c3505cf801cc79872e4/raiden_contracts/contracts/TokenNetwork.sol#L394-L399/>`_). | |||
| The Raiden client must enforce this for the off-chain transferred amounts, contained in the balance proofs (`code here <https://github.com/raiden-network/raiden/blob/71ebf0af650111b3e17de7ee95ad99e8eabc9ecf/raiden/transfer/channel.py#L1332/>`_ and `here <https://github.com/raiden-network/raiden/blob/71ebf0af650111b3e17de7ee95ad99e8eabc9ecf/raiden/transfer/channel.py#L1284/>`_). | |||
| The ``TokenNetwork`` contract must enforce this for deposits (`code here <https://github.com/raiden-network/raiden-contracts/blob/fc1c79329a165c738fc55c3505cf801cc79872e4/raiden_contracts/contracts/TokenNetwork.sol#L306-L308/>`__) and withdraws (`code here <https://github.com/raiden-network/raiden-contracts/blob/fc1c79329a165c738fc55c3505cf801cc79872e4/raiden_contracts/contracts/TokenNetwork.sol#L394-L399/>`__). | |||
There was a problem hiding this comment.
I learned that the double __s make anonymous targets. sphinx-doc/sphinx#3921 (comment) . Otherwise I saw a warning Duplicate explicit target name: "code here".
There was a problem hiding this comment.
yeah that's a tricky part of rst. If you want to later link to the target you can put a single _ but need a unique name
|
Oh no, some warnings are still there. |
LefterisJP
reviewed
Jan 3, 2019
_static/.dummy
Outdated
| @@ -0,0 +1 @@ | |||
| To keep this directory in the git repository. | |||
There was a problem hiding this comment.
why do you want to track an empty directory?
There was a problem hiding this comment.
Otherwise, a Sphinx warning tells me there is no _static directory.
There was a problem hiding this comment.
So I added another sentence saying it's for Sphinx.
| @@ -841,8 +841,8 @@ Protocol Values Constraints | |||
| (3 R) Tk <= Tt, if time k < time t | |||
|
|
|||
| Channel deposits, channel withdraws, off-chain transferred amounts are all monotonically increasing. | |||
| The ``TokenNetwork`` contract must enforce this for deposits (`code here <https://github.com/raiden-network/raiden-contracts/blob/fc1c79329a165c738fc55c3505cf801cc79872e4/raiden_contracts/contracts/TokenNetwork.sol#L306-L308/>`_) and withdraws (`code here <https://github.com/raiden-network/raiden-contracts/blob/fc1c79329a165c738fc55c3505cf801cc79872e4/raiden_contracts/contracts/TokenNetwork.sol#L394-L399/>`_). | |||
| The Raiden client must enforce this for the off-chain transferred amounts, contained in the balance proofs (`code here <https://github.com/raiden-network/raiden/blob/71ebf0af650111b3e17de7ee95ad99e8eabc9ecf/raiden/transfer/channel.py#L1332/>`_ and `here <https://github.com/raiden-network/raiden/blob/71ebf0af650111b3e17de7ee95ad99e8eabc9ecf/raiden/transfer/channel.py#L1284/>`_). | |||
| The ``TokenNetwork`` contract must enforce this for deposits (`code here <https://github.com/raiden-network/raiden-contracts/blob/fc1c79329a165c738fc55c3505cf801cc79872e4/raiden_contracts/contracts/TokenNetwork.sol#L306-L308/>`__) and withdraws (`code here <https://github.com/raiden-network/raiden-contracts/blob/fc1c79329a165c738fc55c3505cf801cc79872e4/raiden_contracts/contracts/TokenNetwork.sol#L394-L399/>`__). | |||
There was a problem hiding this comment.
yeah that's a tricky part of rst. If you want to later link to the target you can put a single _ but need a unique name
This commit is for seeing an error
|
I added an issue to run CI on the spec repository #189 . |
|
@LefterisJP merge? |
LefterisJP
approved these changes
Jan 3, 2019
|
@pirapira thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR turns Sphinx warnings into errors, and fixes them.