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

Provide help for global APIs used at top-level code. #1130

Merged
merged 2 commits into from Nov 29, 2015

Conversation

Projects
None yet
2 participants
@toolness
Member

toolness commented Nov 26, 2015

This fixes #1121.

Right now the only global this PR detects and provides help for is color, as this is one that it seems like beginners often use at top-level code (I stumbled on it when first using p5, and so have others). In the future, though, maybe we could somehow get a list of the global symbols from YUIDoc or something?

For now, are there any other global symbols we should provide help for?

@lmccart

This comment has been minimized.

Show comment
Hide comment
@lmccart

lmccart Nov 26, 2015

Member

awesome! I think random() is another common one, too. yeah, eventually it'd be nice to have the full list pulled from the docs or src, but I don't think it's as high priority.

Member

lmccart commented Nov 26, 2015

awesome! I think random() is another common one, too. yeah, eventually it'd be nice to have the full list pulled from the docs or src, but I don't think it's as high priority.

@toolness

This comment has been minimized.

Show comment
Hide comment
@toolness

toolness Nov 26, 2015

Member

Ah good idea! Just added random.

This makes me wish we could add one of those "anonymous usage reporting" types of features that lots of consumer products have, so that we could get statistics on other kinds of errors folks are making, but that'd probably be hard to do in a way that doesn't violate privacy or otherwise weird people out. Maybe it's just best to encourage teachers to keep a spreadsheet of common errors, as suggested in #971 (comment).

Member

toolness commented Nov 26, 2015

Ah good idea! Just added random.

This makes me wish we could add one of those "anonymous usage reporting" types of features that lots of consumer products have, so that we could get statistics on other kinds of errors folks are making, but that'd probably be hard to do in a way that doesn't violate privacy or otherwise weird people out. Maybe it's just best to encourage teachers to keep a spreadsheet of common errors, as suggested in #971 (comment).

lmccart added a commit that referenced this pull request Nov 29, 2015

Merge pull request #1130 from toolness/issue-1121
Provide help for global APIs used at top-level code.

@lmccart lmccart merged commit 34d88a4 into processing:master Nov 29, 2015

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment