Skip to content

Poor doc #30

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

Open
remster opened this issue Jul 19, 2018 · 0 comments
Open

Poor doc #30

remster opened this issue Jul 19, 2018 · 0 comments

Comments

@remster
Copy link

remster commented Jul 19, 2018

Looking for a gpx parser, i came across yours. Just a note from the first impression:

gpxParse.parseGpxFromFile("/path/to/gpxFile", function(error, data) {
	//do stuff
});

Writing //do stuff hardly gives any hint as to what this does. Is it a pull parser? is it a tree parser? Is it an event driven parser?

If you care, it would do your audience a favour if you pasted one of your test code snippets. It is a tree parser.

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