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

Documentation #168

Open
Monte-Carlo opened this issue Nov 20, 2023 · 1 comment
Open

Documentation #168

Monte-Carlo opened this issue Nov 20, 2023 · 1 comment

Comments

@Monte-Carlo
Copy link

Hello rabpro team,

I've been exploring the rabpro package and have found it to be a great tool. During my usage, I came across two minor issues in the documentation that I thought to bring to your attention for clarification and correction:

Environment Variable Setup Instruction:

In the section describing how to change the path using os.environ['RABPRO_DATA'] = 'path/to/rabpro/data', it might be helpful to note that this step needs to be done before importing the package. A small comment or note in the documentation could assist new users in correctly setting up their environment.

Function Name Mismatch:

In the section for downloading the MERIT DEM data, the function call is listed as data_utils.download_merit_dem("n30w120", your_username, your_password). However, I believe the correct function name should be download_merit_hydro.

Thank you for developing and maintaining.

Best regards,

Ralf

jsta added a commit that referenced this issue Dec 4, 2023
@jsta
Copy link
Member

jsta commented Dec 26, 2023

Thanks Ralf, I've fixed the Function Name Mismatch typo. Can you tell me what happens if you don't set RABPRO_DATA before importing? To me, that should still work after importing.

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

No branches or pull requests

2 participants