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
We are also missing a blurp for the backend itself, which we should add, I think, so that it is more like:
backend_name : backend_summary
<additional docs if available>
Whether the additional parameters (if they exist) should be part of the additional docs or explicitly listed, I have no opinion for.
I am sure we can imagine a lot of additional tooling for the final deployed html docs!
Maybe we can manage to keep spatch simple, but just make things like additional_parameters availbe via a hook? I.e. a format_backend_docs() hook that is passed the information, and the default is just the above?
(I suppose that might get us eventually in the realm where subclassing BackendSystem to customize these functions makes sense.)
I suspect this isn't a huge priority or problem; mainly because it seems easy to extend. But as soon as a downstream project builds html docs and wants to include backends (or explicitly not include internal backends), we'll have to do something.
Activity