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

Improve documentation around arrays as values of properties #216

Open
3 tasks
Pfeil opened this issue Jan 13, 2025 · 0 comments
Open
3 tasks

Improve documentation around arrays as values of properties #216

Pfeil opened this issue Jan 13, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Pfeil
Copy link
Member

Pfeil commented Jan 13, 2025

This issue is opened as a response to #215.

  • document the purpose of add* and set* methods in builders and their difference
  • include array tests like encodingFormat if not already available and test/demonstrate if we can do this with the current API:
{
    "@id": "1st-tool.cwl",
    "@type": "File",
    "name": "First executable tool",
    "description": "An example Common Workflow Language File",
    "contentSize": "120",
    "encodingFormat": ["text/plain", {"@id": "https://www.commonwl.org/v1.0/Workflow.html"}]
  }
  • There was no code given which generates this, but make sure this error message is only given in appropriate contexts:
[ {
  "@id" : "xsd:string"
} ]
does not comply with the flattened structure of the RO-Crate json document.
@Pfeil Pfeil added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant