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

Added link to excelparser from tools for documentation of excel sheet. #594

Merged
merged 3 commits into from
Apr 25, 2023

Conversation

francescalb
Copy link
Collaborator

Description:

The tool page for the excelparser has very little documentation on the required structure of the excelsheet.
It is important to not have several places with documentation what might diverge in the future so only a link is added to the tools readme.

Type of change:

  • Bug fix.
  • New feature.
  • Documentation update.

Checklist:

This checklist can be used as a help for the reviewer.

  • Is the code easy to read and understand?
  • Are comments for humans to read, not computers to disregard?
  • Does a new feature has an accompanying new test (in the CI or unit testing schemes)?
  • Has the documentation been updated as necessary?
  • Does this close the issue?
  • Is the change limited to the issue?
  • Are errors handled for all outcomes?
  • Does the new feature provide new restrictions on dependencies, and if so is this documented?

Comments:

@francescalb francescalb linked an issue Apr 24, 2023 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Apr 24, 2023

Codecov Report

Merging #594 (d52ddb4) into master (c1137b7) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #594   +/-   ##
=======================================
  Coverage   67.25%   67.25%           
=======================================
  Files          16       16           
  Lines        3127     3127           
=======================================
  Hits         2103     2103           
  Misses       1024     1024           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Collaborator

@jesper-friis jesper-friis left a comment

Choose a reason for hiding this comment

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

I approve since It make no sense to delay merging this into master.

However, it may still be useful to extend this documentation with a tutorial with screenshots of the different tabs and a short description of what the user is supposed to fill it in.

It can be followed up with the current example

@francescalb francescalb merged commit aefae16 into master Apr 25, 2023
@francescalb francescalb deleted the 593-point-to-excelparser-api-from-the-tools-page branch April 25, 2023 06:33
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.

Point to excelparser api from the tools-page
2 participants