search

equinor / webviz-config

Make Dash applications from a user-friendly config file :book: :snake:
https://github.com/orgs/equinor/projects/24
MIT License
54 stars 39 forks source link

Improve documentation of TablePlotter #397

Open asnyv opened 3 years ago

asnyv commented 3 years ago

User request that especially the plot_options argument is better described in the documentation. That is: what are valid plot_options?

Rishabhraghwendra18 commented 3 years ago

Hi...May I help you in this ?

asnyv commented 3 years ago

Hi...May I help you in this ?

Of course @Rishabhraghwendra18 😊 Probably mainly to take a look at the plot options defined in the TablePlotter and compare them with their definitions in Plotly express (which is what we use). The documentation is autogenerated from the plugin docstring, so the plugin docstring is what we need to improve.

Rishabhraghwendra18 commented 3 years ago

@asnyv Thanks buddy..🤗 . may you assign it to me ?

Rishabhraghwendra18 commented 3 years ago

@asnyv I am new to open source contribution . May you tell me in which folder TablePlotter docs is present ?

asnyv commented 3 years ago

Hi @Rishabhraghwendra18!

The doc is generated from the docstring here: https://github.com/equinor/webviz-config/blob/d4bda222cb58aed6050b049473e4cd1a3a76b8d3/webviz_config/generic_plugins/_table_plotter.py#L22-L42

It follows a markdown syntax, and you can check how your updates turn out by running the command line tool webviz docs press webviz-config package in the menu on the left hand side, go to the TablePlotter and press Arguments

asnyv commented 3 years ago

Like this: image

So what we want is to improve the marked plot_options argument