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

Review existing code and check documentation #10

Closed
kaufmanno opened this issue Nov 6, 2020 · 7 comments
Closed

Review existing code and check documentation #10

kaufmanno opened this issue Nov 6, 2020 · 7 comments
Labels
documentation Improvements or additions to documentation

Comments

@kaufmanno
Copy link
Owner

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.

@kaufmanno kaufmanno added the documentation Improvements or additions to documentation label Nov 6, 2020
@kaufmanno kaufmanno added this to the 2020 project specifications milestone Nov 6, 2020
@kaufmanno
Copy link
Owner Author

kaufmanno commented Nov 13, 2020

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.

@YanickNdepo
Copy link
Collaborator

YanickNdepo commented Nov 13, 2020

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

@YanickNdepo
Copy link
Collaborator

YanickNdepo commented Nov 13, 2020

For the structure of the documentation, titles (H1, H2, …) are note used efficiently.
For enhancement, try if possible to make a documentation with sections and subsections by using these styles (H1, H2, ...).

issue #18

@YanickNdepo
Copy link
Collaborator

YanickNdepo commented Nov 13, 2020

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).
issue #23

@YanickNdepo
Copy link
Collaborator

YanickNdepo commented Nov 13, 2020

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

@YanickNdepo
Copy link
Collaborator

YanickNdepo commented Nov 13, 2020

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

@kaufmanno
Copy link
Owner Author

kaufmanno commented Nov 13, 2020

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.

@YanickNdepo Could you open an issue?

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