Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add user docs #232

Merged
merged 1 commit into from
Jun 25, 2024
Merged

add user docs #232

merged 1 commit into from
Jun 25, 2024

Conversation

misterbrandonwalker
Copy link
Member

Documentation for parallel flag, partial failures flag and best practices for javascript snippets.

@sameeul sameeul requested a review from vjaganat90 June 21, 2024 13:46
@vjaganat90
Copy link
Member

After the one additional line needed it is ready to merged.


## Partial Failures
When the partial failures feature is enabled although the subprocess for the workflow step itself will pass, the post-processing javascript can potentially crash as seen below. The corresponding cwl snippet is also shown.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is prudent to mention that Sophios compiler only semantically understands Sophios/CWL. It is impossible (theoretically impossible) to guard/correct mistakes in the embedded JS of any arbitrary workflow. Otherwise this doc is fine.

@misterbrandonwalker misterbrandonwalker force-pushed the doc_update branch 2 times, most recently from c067721 to 3efcb98 Compare June 25, 2024 16:13
@sameeul sameeul merged commit 0ef6e46 into PolusAI:master Jun 25, 2024
1 check passed
sameeul added a commit that referenced this pull request Jul 9, 2024
* Minor documentation update

* Minor documentation update

* Minor documentation update

* 'when' tag support in Python API

* Minor refactor (#242)

* minor correction to docstring

* copy & paste cwl-docker-extract code from main.py

* update userguide with python API docs

* fix step_key evaluation in get_workflow_outputs

* add user docs (#232)

Co-authored-by: Brandon Duane Walker <walkerbd@UPDATEME.HOSTNAME.COM>

* add required files for rest api (core) (#247)

* add required files for rest api (core)

* add a single node/step workflow test rest api

* add orjson as dep and pytest fix gha

---------

Co-authored-by: Vasu Jaganath <vasu.jaganath@axleinfo.com>

* Update pyproject.toml for release

---------

Co-authored-by: Vasu Jaganath <vasu.jaganath@axleinfo.com>
Co-authored-by: Jake Fennick <jake.fennick@axleinfo.com>
Co-authored-by: Brandon Walker <43654521+misterbrandonwalker@users.noreply.github.com>
Co-authored-by: Brandon Duane Walker <walkerbd@UPDATEME.HOSTNAME.COM>
Co-authored-by: VasuJ <145879890+vjaganat90@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants