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

Clean up plot by related dx function documentation #1066

Open
jnumainville opened this issue Dec 17, 2024 · 0 comments
Open

Clean up plot by related dx function documentation #1066

jnumainville opened this issue Dec 17, 2024 · 0 comments
Labels
bug Something isn't working triage

Comments

@jnumainville
Copy link
Collaborator

Some function documentation is not clear, especially in regards to plot by functionality.

For example, for line:

width: A column or list of columns that contain width values.
  The value is used for a plot by on width.
  See width_map for additional behaviors.

The first line implies that the column itself can contain width values, but this isn't allowed at this time. The second sentence attempts to clarify this, but it would be better if the first sentence wasn't misleading in the first place.

@jnumainville jnumainville added bug Something isn't working triage labels Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working triage
Projects
None yet
Development

No branches or pull requests

1 participant