You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There are some inherited fields that in some classes can be modified by the users, while in others they can't be (set as Literal[single_option] = single_option). To avoid confusion, it could be better to completely avoid documenting those fields in classes where they cannot be modified.
The two examples currently are monitor.colocate in some monitors, and monitor.interval_space in some monitors. There could be others in the future too.
The text was updated successfully, but these errors were encountered:
This is currently pretty tricky to do within our sphinx functionality and configuration. This is some functionality that we can implement within our custom sphinx extension in a more defined manner.
Hence, will migrate this issue to the autoflex documentation extension exploration project.
There are some inherited fields that in some classes can be modified by the users, while in others they can't be (set as
Literal[single_option] = single_option
). To avoid confusion, it could be better to completely avoid documenting those fields in classes where they cannot be modified.The two examples currently are
monitor.colocate
in some monitors, andmonitor.interval_space
in some monitors. There could be others in the future too.The text was updated successfully, but these errors were encountered: