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

Missing documentation. #29

Open
jfjlaros opened this issue Sep 4, 2023 · 2 comments
Open

Missing documentation. #29

jfjlaros opened this issue Sep 4, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@jfjlaros
Copy link
Member

jfjlaros commented Sep 4, 2023

The Batch Processor page contains no information about the input format, nor are there any examples given.

@jfjlaros jfjlaros added the documentation Improvements or additions to documentation label Sep 5, 2023
mihailefter added a commit that referenced this issue Sep 14, 2023
@mihailefter
Copy link
Contributor

Some details about the input/output formats were added to the Batch Processor.
@jfjlaros Could you please have a look?

@jfjlaros
Copy link
Member Author

That looks like a good start, a few remarks:

  • It would be good to also show the input file as a table to make the relationship between the input and the output more clear.
  • Fields in column 5 and 6 contain N/A when their content equals the normalised description. It would be better to show a copy of the normalised description instead.
  • I am not sure the mouse over hints are very helpful (and sometimes they are wrong, e.g., the first entry in column 6), it would be better to explain the format in more detail.

mihailefter added a commit that referenced this issue Oct 31, 2023
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
Projects
None yet
Development

No branches or pull requests

2 participants