-
Notifications
You must be signed in to change notification settings - Fork 305
Open
Description
After we use black
to format python code, it looks like the doctsring of python is not aligned as black
indent the top one but does not indent the whole string. As an example, below is the docstring after black
:
def resample(
input, rate_in, rate_out, quality, name=None
): # pylint: disable=redefined-builtin
"""Resample audio.
Args:
input: A 2-D `Tensor` of type `int16` or `float`. Audio input.
rate_in: The rate of the audio input.
rate_out: The rate of the audio output.
quality: The quality of the resample, 1-10.
name: A name for the operation (optional).
Returns:
output: Resampled audio.
"""
But instead we should have the following:
def resample(
input, rate_in, rate_out, quality, name=None
): # pylint: disable=redefined-builtin
"""Resample audio.
Args:
input: A 2-D `Tensor` of type `int16` or `float`. Audio input.
rate_in: The rate of the audio input.
rate_out: The rate of the audio output.
quality: The quality of the resample, 1-10.
name: A name for the operation (optional).
Returns:
output: Resampled audio.
"""
Otherwise docs team may have trouble generating the website. (and the non-aligned one does not look good aesthetically).
This is an issue we need fix before v0.13.0.