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

Documentation needs to be more descriptive. #1

Open
iwbnwif opened this issue Apr 17, 2016 · 0 comments
Open

Documentation needs to be more descriptive. #1

iwbnwif opened this issue Apr 17, 2016 · 0 comments
Assignees

Comments

@iwbnwif
Copy link
Owner

iwbnwif commented Apr 17, 2016

From @iwbnwif on April 17, 2016 10:55

The documentation is, in a great many places, pretty scant. For example:

void NumberAxis::SetLabelCount (size_t labelCount) [inline]
Sets count of labels.
Parameters:
labelCount count of labels

This doesn't really give any indication of what effect this method has on an axis. For example a better description could be:

Sets the number of text labels that are drawn on the axis. The numeric interval between the labels is determined by the range (i.e. Max - Min values) of the axis. For example, if the range is 0 - 100 and SetLabelCount(6) is called, then labels will be drawn at 0, 20, 40, 60, 80 and 100.

See also: SetFixedBounds, IntegerValues, SetTickFormat, SetLabelSkip

Ideally these sort of methods should be a accompanied by a graphic of the resulting chart, or perhaps introduce an "Axis Overview" section.

Copied from original issue: pbfordev/wxFreeChart#2

Specific areas to improve:

  1. New event mechanism
  2. New dataset, dataseries and datapoint schema
  3. New and existing visual presentation options
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant