Function description from docstring #1700
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Awesome; this is a great idea. Good call and nicely done! I was just about to comment, when this statement clued in for me. Let's see how this looks once the "parent" PR lands, but generally 👍 . |
chris-janidlo
force-pushed
the
function-description-from-docstring
branch
from
a9c634f to
36607d6
Compare
chris-janidlo
requested review from
yadudoc,
ryanchard,
rjmello,
khk-globus and
LeiGlobus
khk-globus
reviewed
Nov 11, 2024
changelog.d/20241101_155044_chris_function_description_from_docstring.rst
Show resolved
Hide resolved
chris-janidlo
force-pushed
the
function-description-from-docstring
branch
from
36607d6 to
7dd2aa9
Compare
khk-globus
reviewed
Nov 14, 2024
khk-globus
reviewed
Nov 14, 2024
chris-janidlo
force-pushed
the
function-description-from-docstring
branch
from
7dd2aa9 to
d8fd266
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Following our UI discussion today, it occurred to me that we don't have a user-friendly way to add a description to a function. Reading docstrings like this is really easy, so figured I'd knock it out while its on my mind (even though we don't really do anything with function descriptions yet).
Currently includes the changes from the other work it's based off of from #1699, hence the draft mode.[sc-37237]
Type of change