Docs edits #706
Docs edits #706
Conversation
docs/source/custom_resolvers.rst
Outdated
| Custom resolvers support variadic argument lists in the form of a comma separated list of zero or more values. | ||
| Whitespaces are stripped from both ends of each value ("foo,bar" is the same as "foo, bar "). | ||
| Custom resolvers support variadic argument lists in the form of a comma-separated list of zero or more values. | ||
| In a variadic argument list, whitespace is stripped from the ends of each value ("foo,bar" gives the same result as "foo, bar "). | ||
| You can use literal commas and spaces anywhere by escaping (:code:`\,` and :code:`\ `), or |
There was a problem hiding this comment.
At a glance, :code:,`` looks like a surrounding double backticks. If so, I suggest we switch to double backtick for consistency with the rest of the doc.
There was a problem hiding this comment.
The doc build fails if I use double backticks for the one with the space. I think that the backslash is causing some escaping problem.
docs/source/structured_config.rst
Outdated
| >>> # Okay, "20" can be converted to an int | ||
| >>> conf.ints["e"] = "20" |
There was a problem hiding this comment.
We are thinking about deprecating the automatic conversion on assignment because it triggers a typing error (#459).
Don't document the automatic conversion, just the straight forward valid assignment and the hard error.
For the other instance, using double backticks seems to cause sphinx-build to fail.
Co-authored-by: Omry Yadan <[email protected]>
| You can use literal commas and spaces anywhere by escaping (:code:`\,` and :code:`\ `), or | ||
| Custom resolvers support variadic argument lists in the form of a comma-separated list of zero or more values. | ||
| In a variadic argument list, whitespace is stripped from the ends of each value ("foo,bar" gives the same result as "foo, bar "). | ||
| You can use literal commas and spaces anywhere by escaping (``\,`` and :code:`\ `), or |
There was a problem hiding this comment.
The docs build fails if I change the :code:\ to use double backticks. I think the backslash is causing an escaping problem.
| You can use literal commas and spaces anywhere by escaping (:code:`\,` and :code:`\ `), or | ||
| Custom resolvers support variadic argument lists in the form of a comma-separated list of zero or more values. | ||
| In a variadic argument list, whitespace is stripped from the ends of each value ("foo,bar" gives the same result as "foo, bar "). | ||
| You can use literal commas and spaces anywhere by escaping (``\,`` and :code:`\ `), or |
Related to #689Closes #689