Ross Barnowski

Results 471 comments of Ross Barnowski

I think there are a few things going on here. First, re: the formatting difference - by default numpydoc creates links to the full property description. In this case, the...

In fact, it looks like autosummary actually explicitly handles the `i.e.` case: https://github.com/sphinx-doc/sphinx/blob/487b8436c6e8dc596db4b8d4d06e9145105a2ac2/sphinx/ext/autosummary/__init__.py#L548-L568 (see `WELL_KNOWN_ABBREVIATIONS`).

In principle it'd be nice to add related checks to the docstring validation as well, to help codify the updates to the standard.

> Just to follow up on this since it's been a few months, is there a timeline for deciding on this? Thanks! I'm generally in favor, though I do think...

> it didn't seem like there was a validation for "optional" either (though I'm not particularly familiar with the source code). I'm wondering if it would be helpful to include...

This is just a style choice and is not officially part of the numpydoc standard --- either is equally valid. There is a [docstring validation feature](https://numpydoc.readthedocs.io/en/latest/validation.html#docstring-validation-during-sphinx-build) that will be part...

Adding the following pattern to the standard: ``` Returns ------- name : description ``` seems fine to me. As noted, it's backward-compatible from the perspective of docstring parsing as this...

One of the main questions from me re: gitpod/codespaces is what is the end-goal of having a development environment for the `numpy-tutorials` repo? If it's to interactively edit the notebooks...

Thanks for the suggestions @trsvchn . The main issue seems to be that the `edit this page` feature of the sphinx book theme doesn't work properly because of the symlinked...

I think the problem stems from the fact that, in your example, the link that the reference is supposed to resolve to occurs outside of the `References` section. i.e. if...