Remove the unnecessary double backticks on 'validator' in docstring.

The usual convention is that we mark function parameters in docstrings with
double backticks. There is no (longer a) parameter called 'validator' so we
update the docstring to conform to the convention.
This commit is contained in:
Alex Stokes 2019-01-30 18:38:12 -08:00
parent e400c28372
commit 750790c784
No known key found for this signature in database
GPG Key ID: 51CE1721B245C086
1 changed files with 1 additions and 1 deletions

View File

@ -1020,7 +1020,7 @@ def is_power_of_two(value: int) -> bool:
```python ```python
def get_effective_balance(state: State, index: ValidatorIndex) -> Gwei: def get_effective_balance(state: State, index: ValidatorIndex) -> Gwei:
""" """
Return the effective balance (also known as "balance at stake") for a ``validator`` with the given ``index``. Return the effective balance (also known as "balance at stake") for a validator with the given ``index``.
""" """
return min(state.validator_balances[index], MAX_DEPOSIT_AMOUNT) return min(state.validator_balances[index], MAX_DEPOSIT_AMOUNT)
``` ```