search

atcollab / at

Accelerator Toolbox
Apache License 2.0
48 stars 31 forks source link

Documentation of plot_beta #617

Closed lfarv closed 1 year ago

lfarv commented 1 year ago

Answer the issue #614.

To avoid repeating the documentation of the generic base function, the doc of specific functions (plot_beta, plot_linear, plot_trajectory) links to the underlying baseplot function.

Is this clear enough, or should we fully duplicate to common part ?

swhite2401 commented 1 year ago

I have been duplicating the full help for each function. It makes it easier to get the information on the webpage

lfarv commented 1 year ago

@swhite2401

I have been duplicating the full help for each function.

Did you commit that? I can't find it

swhite2401 commented 1 year ago

Ah sorry I ment in previous devs, see acceptance for instance. I did not do anything on this branch

lfarv commented 1 year ago

Ok, I replicated the help I'm all functions

simoneliuzzo commented 1 year ago

looks ok for me. secret options now will be known to the user that rely on the AT help.