globus / globus-compute

Globus Compute: High Performance Function Serving for Science

https://www.globus.org/compute

Apache License 2.0

148 stars 47 forks source link

Function description from docstring #1700

Closed chris-janidlo closed 1 week ago

chris-janidlo commented 3 weeks ago

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.~~

Type of change

New feature (non-breaking change that adds functionality)

khk-globus commented 3 weeks ago

Currently includes the changes from the other work it's based off of from https://github.com/globus/globus-compute/pull/1699, hence the draft mode.

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 :+1: .