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

Q&A #322

Closed
wants to merge 3 commits into from
Closed

Q&A #322

wants to merge 3 commits into from

Conversation

achaikou
Copy link
Contributor

3 sections that I felt are missing from documentation and which I myself would like to see as a user.

  • Section for people who landed up on this project page but are totally clueless about what's going on and need to figure out if they should investigate dlisio further.
  • Section for people who received one of our errors and are actually at loss with regards to what they should do about it. (aka the most common situation that I saw which lead to the provided error)
  • Section for some future dlisio developers. Most likely no-one ever will find it useful, but as I already acquired some dlis debugging mindset, it probably makes sense to share it.

Feel free to completely annihilate small/big/all parts of this PR. Mark everything that seems unclear on first read, it will likely be the same for users.

Q&A for people who just stumbled upon dlisio and want to know if it
fits their needs.
Errors reference for people wanting more information about what is
wrong with their files.
Investigation hints for future dlisio developers.
@ErlendHaa
Copy link
Contributor

ErlendHaa commented May 31, 2021

Closes #102
Closes #217

@achaikou
Copy link
Contributor Author

To be updated some undefined time in the future:

  • Move "Can I be sure that dlisio presents me the data correctly?" section to Readme
  • Remove everything else from Q&A, thus dropping explanations for clueless repo viewers
  • Add Errors explanation section under dlis, while removing everything that doesn't correspond to literal error string (aka performance messages).
  • (Check that messages still make sense)
  • Put investigation guide in the docs, but never link it publicly.

@lucasblanes
Copy link

Hello! I don't know if this is the best place to ask, but can I create DLIS files using DLISio?

@achaikou
Copy link
Contributor Author

Hi @lucasblanes !

No, this is a place for proposed changes to the code. But I see why the title caused confusion :)
Better place to ask questions is Issues as it can be searched by others wondering the same.

To the question itself:
no, dlisio can't write dlis files. At the moment there are no plans to support it in any foreseeable future.

@lucasblanes
Copy link

Hello @achaikou ! Sorry for the confusion and thank you for your answer!

@achaikou achaikou closed this Mar 9, 2022
@achaikou achaikou deleted the faq branch March 18, 2022 10:56
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