-
Notifications
You must be signed in to change notification settings - Fork 1
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
Review existing code and check documentation #10
Comments
In the documentation, the explanation of the "Example of reading borehole data from electrodes string files inserted into a sqlite database" is not fully correct. -> we opened issue #14 to improve it. |
The overall directories structure of the project does not facilitate searching file. we must make a clear structure with specific directories like notebooks, test_notebooks, database (data files and sqliteDB file), ... Also, put a single notebook, in which all the 'small' codes are gathered, in the root directory will be more efficient for executing code step by step. we created an issue #15 |
For the structure of the documentation, titles (H1, H2, …) are note used efficiently. issue #18 |
Another thing (always in the documentation) is to make a sort of menubar (at the leftside) that allows to scroll the main text without scroll the menu. This will allows the reader to navigate easily in the documentation (example of https://striplog.readthedocs.io/en/latest/api/striplog.utils.html). |
For striplog, improve the code to show only legends that are used beside the striplog. If it is possible, show the value of depth (1m, 2m, ...) to avoid reading difficulties. An issue has been created #19 |
There is no informations about the interest of each steps in each section of the documentation. The purpose of each task must be wrote for a better understanding of code. issue #20 |
@YanickNdepo Could you open an issue? |
Look at the available code (in python files '.py' and jupyter notebooks '.ipynb') to understand what it is used for and check if this is properly explained in the documentation. Make suggestions of improvements.
The text was updated successfully, but these errors were encountered: