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

Update Error Docs #11009

Merged
merged 2 commits into from
May 1, 2015
Merged

Update Error Docs #11009

merged 2 commits into from
May 1, 2015

Conversation

sjkelly
Copy link
Contributor

@sjkelly sjkelly commented Apr 25, 2015

As discussed in #7766, this changes the documentation of subtypes of exceptions from data to function. It also provides documentation for all exported Exception types, and their corresponding arguments. I tried to provide general explanations for the errors based on how I saw they were being used in base/ or src/.


.. function:: OutOfMemoryError()

A generated syntax tree was too large for the available memory.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this specific to "syntax tree"s or can it also happen for say very large arrays?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right, this applies more than just ASTs. I will update and squash.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tkelman updated with more general wording.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still see "A generated syntax tree was too large for the available memory."?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be fixed now. For some reason I need to remove helpdb.jl on my system to get it to update.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah looks better now - some of the makefile dependencies are probably a little off for the doc building.

Last minor nit, I think "a wraparound" would be better than "an wraparound"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, that typo should be fixed now!

tkelman added a commit that referenced this pull request May 1, 2015
@tkelman tkelman merged commit 85a2a3a into JuliaLang:master May 1, 2015
@sjkelly sjkelly deleted the sjk/error-docs branch May 1, 2015 15:18
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

Successfully merging this pull request may close these issues.

2 participants