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

doc issues: error's documentation enhancement and merge with FAQ #1676

Open
bearecinos opened this issue Jan 16, 2024 · 0 comments
Open

doc issues: error's documentation enhancement and merge with FAQ #1676

bearecinos opened this issue Jan 16, 2024 · 0 comments

Comments

@bearecinos
Copy link
Member

bearecinos commented Jan 16, 2024

Dealing with errors. This post is great, but I think it does not deal with errors when you are writing your own loop. Probably having a section on how to deal with AssertionError’s or where to find a list of glaciers that fail and how to remove them from your working directory will help (@bearecinos has some tutorial on that can share / push).

One thing that @ehultee noticed, is that this section is also not the same as the “Help, an error!” page that @anoukvlug promoted in #support .

Here is something @Suther11LBU suggested to avoid the confusion.

  • We need to define what we mean by 'error' here as having two pages with a similar name is confusing. @anoukvlug recent "Help, an error!" page is more about how/where users should direct their questions if they're struggling. Both pages could be merged or we just change the title of one?

  • Yet other errors are discussed on the FAQ page. @ehultee suggest this information be removed from FAQ and moved to the “Dealing with errors” tutorial notebook with examples.

  • FAQ on docs website is not aligned with resources elsewhere. See above note about specific errors on the FAQ page. Immediately below there is a response about using one’s own input data, and the “have a look at this tutorial!” link goes to 404.

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

1 participant