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

CLI & docs: robot convert --format #1114

Open
3 tasks
joeflack4 opened this issue Apr 25, 2023 · 3 comments
Open
3 tasks

CLI & docs: robot convert --format #1114

joeflack4 opened this issue Apr 25, 2023 · 3 comments

Comments

@joeflack4
Copy link

joeflack4 commented Apr 25, 2023

Overview

In my opinion, the language of the robot convert docs does not entirely make it clear that all of the formats listed are both valid input formats and output formats, though I think that is the case. Although probably intuitive, it is also unclear that the --format option applies to output and not input, so some clarity on that would be helpful. Finally, I think it would be good to allow flags for both --output-format and --input-format. In my experience in the ontology world, I find files with extensions that aren't canonical / aren't reflective of the actual serialization. As a non-expert in many of these formats, it's sometimes not clear for me what file extension to use myself, but if I have an enumeration of --input-format and --output-format to choose from, this gives me confidence that the tool is interpreting things correctly.

Propositions

Related

@joeflack4 joeflack4 changed the title CLI & Docs: robot convert --format CLI & docs: robot convert --format Apr 25, 2023
@balhoff
Copy link
Contributor

balhoff commented Apr 27, 2023

@joeflack4 we have an open PR for --input-format: #1056 This feature does have some complications stemming from automatic loading of ontology imports (discussed in the PR).

@jamesaoverton
Copy link
Member

I should also note: the input and output formats are not exactly the same. JSON input (JSON-LD) and JSON output (OBO Graphs) are different, for example.

@joeflack4
Copy link
Author

@balhoff Ah, sorry I didn't even think to search this time! I edited that related issue into the OP.

@jamesaoverton Ah! Exactly the kind of thing to disambiguate in the docs, thanks.

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

No branches or pull requests

3 participants