Форматирование знаков препинания в docstring - PullRequest
0 голосов
/ 21 апреля 2020

Если я ссылаюсь на переменную с кавычками в строке документации, грамматика английского языка sh говорит о том, что нужно поместить любую подходящую пунктуацию в кавычки. Например, возьмем следующее предложение, описывающее некоторую функцию округления:

Iterate over an array of values between 0 and 1, rounding up for all values above "thresh."

Это не должно приводить к путанице, но, очевидно, имя переменной - thresh, а не thresh. Имеет ли смысл размещать знаки препинания за кавычками?

...