Add validate_flow operation to FlowsClient
#979
Conversation
Signed-off-by: Ada <[email protected]>
Signed-off-by: Ada <[email protected]>
ada-globus
requested review from
derek-globus,
kurtmckee,
sirosen and
aaschaer
as code owners
| @@ -46,14 +46,14 @@ def create_flow( | |||
| additional_fields: dict[str, t.Any] | None = None, | |||
| ) -> GlobusHTTPResponse: | |||
| """ | |||
| Create a Flow | |||
| Create a flow | |||
There was a problem hiding this comment.
We need a style-guide for this. We started using emphasis (boldface, IIRC?) in some of the docs for flow, run, timer, and other proper nouns which are easily confused with service names.
There was a problem hiding this comment.
Yeah, I think the way I'd phrase it is roughly:
Entities (e.g., flow, run, action, action provider) are lowercase and first appearance is set off as a "term" in whatever paradigm a given document uses; for the docs site, we use bold
Is there such a paradigm—or related prior-art—in the SDK docs? If so, happy to make consistent!
| @@ -46,14 +46,14 @@ def create_flow( | |||
| additional_fields: dict[str, t.Any] | None = None, | |||
| ) -> GlobusHTTPResponse: | |||
| """ | |||
| Create a Flow | |||
| Create a flow | |||
There was a problem hiding this comment.
We need a style-guide for this. We started using emphasis (boldface, IIRC?) in some of the docs for flow, run, timer, and other proper nouns which are easily confused with service names.
|
@sirosen Yeah, wasn't planning to merge til the Flows release hits next week—and CLI will be prepped for when that occurs :) |
I added a quick copyedit commit to normalize capitalization of "flow" and "run", which appeared to be inconsistent. It's not per se part of the scope, but was very fast and relevant to matching the new docstring for
validate_flow. If it's a significant barrier to getting this merged, I can break it into a separate PR.📚 Documentation preview 📚: https://globus-sdk-python--979.org.readthedocs.build/en/979/