docs: Document the syntax we use for autogenerating frontend forms from run function docstrings
#1778
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
mieubrisse
changed the title
run function docstrings
adschwartz
reviewed
Nov 14, 2023
adschwartz
approved these changes
Nov 14, 2023
|
@mieubrisse this is excellent and I particularly like that you added in which primitives and complex data types we support (including JSON being a fallback) as that isn't obvious otherwise |
Deploying with
|
| Latest commit: |
f9255b8
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://44bdd2a0.kurtosis-docs.pages.dev |
| Branch Preview URL: | https://kevin-docstring-format.kurtosis-docs.pages.dev |
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:
The docstring syntax that we automatically translate into a form was undocumented. This PR adds documentation for it, so that users can self-serve their own form generation.
Is this change user facing?
YES