You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There has been a good initial effort to have proper documentation. However, we could benefit by making small changes.
ReadMe:
The background seems a bit too wordy and lengthy. Do we need the background? I do not think we need the motivation if we already have the background.
Are we calling them CLIs are they not commands. The description of the commands are very long. Do we really need to put that we have a .csv format in the readme? This should probably go to docs.
I would put the image at the top as the most clear visual indicator.
Why is the word Contribute in uppercase but Install isn't? Maybe just write the word Contribute instead of How to Contribute.
How to use should be after install. Order should be install, use, contribute, cite, license.
Contributing:
Should include contact information so people can reach out to us.
Should also link to the testing and code formatting docs when developed.
Naming: the namings in docs should be standardised as some are in capital letters others are not. Maybe change to MODELS and FILES, then TESTS and CODESTYLE
Tutorial:
Here is where there should be more information about the commands and what they do. The texts that are in the readme should come here.
A video should be filmed on how to use the more interactive CLI.
Also information on the figures produced and the file names produced. This have been updated.
Models:
We are missing information about scalers and feature extension.
The text was updated successfully, but these errors were encountered:
There has been a good initial effort to have proper documentation. However, we could benefit by making small changes.
ReadMe:
Contributing:
Naming: the namings in docs should be standardised as some are in capital letters others are not. Maybe change to MODELS and FILES, then TESTS and CODESTYLE
Tutorial:
Models:
The text was updated successfully, but these errors were encountered: