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

Clearly separate input and output options in the documentation #1043

Open
jidanni opened this issue Mar 25, 2023 · 1 comment
Open

Clearly separate input and output options in the documentation #1043

jidanni opened this issue Mar 25, 2023 · 1 comment

Comments

@jidanni
Copy link
Contributor

jidanni commented Mar 25, 2023

Let's take
https://www.gpsbabel.org/htmldoc-development/fmt_kml.html
https://www.gpsbabel.org/htmldoc-development/fmt_unicsv.html
we have to look carefully at each option, to tell if it is for input, or
output.

Perhaps each such page should group them into two groups, with a
<HR> (horizontal rule)
between the two groups.

Here is an example of the old bad way:

lines option
Export linestrings for tracks and routes.

When this option is nonzero, GPSBabel draws lines between points in tracks and routes. The default value for this option is 1, which causes lines to be drawn by default. To disable line-drawing, specify lines=0.

Hmm, "draws". So this must be an output option: we are to use

  • -o kml,lines=1

not

  • -i kml,lines=1

But things would be much clearer if each documentation page were split into a top half talking about input options, and a bottom half talking about output options. Yes, and maybe a third cross-gender option section.

Actually on https://www.gpsbabel.org/htmldoc-development/fmt_unicsv.html
I found a line that looks like my <HR>, an informal separator:

On the output side unicsv writes fixed number of columns (waypoint index, latitude...

@tsteven4
Copy link
Collaborator

I agree that documenting if a format option effects the reader, the writer, real time positioning, or combination of those, would be an improvement. Volunteers?

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