Add explanation docs about APIs #6289
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #6289 +/- ##
===========================================
- Coverage 81.91% 71.56% -10.36%
===========================================
Files 310 310
Lines 45992 45996 +4
===========================================
- Hits 37676 32917 -4759
- Misses 8316 13079 +4763
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Looks good. For expedience I pushed some direct edits to the PR, so please review that commit and make sure I didn't break anything. :-) I think this guide helps, but I still think we'll need more info, e.g. "what are all the cases where I can provide a parameter object and it will be treated as a reactive object"? Clearly some Panel objects accept them for Parameter values; is it all Panel objects, for all Parameters?
doc/explanation/api/index.md
Outdated
| :link: reactivity | ||
| :link-type: doc | ||
|
|
||
| A discussion that contrasts reactive and callback based APIs in Panel. |
There was a problem hiding this comment.
I'm not sure "discussion" adds much here.
There was a problem hiding this comment.
Might misunderstand the above context, but I think I ran into the above issue when using layouts. To my surprise it was quite easy (for Philip at least :-) ) to update this in the Panel code for Flexbox. See below.
A number of ListLike layouts do not support objects = at the moment. The PR below would fix that and make behaviour more uniform.
I Made a PR for Flexbox, Philip, was able to fix it with +- 5 lines of changed code. At his request I made this PR for the other layouts: #6389
ceae2dc to
3600d25
Compare
Clarified some of the explanations.
3600d25 to
b2a215d
Compare
In this PR I plan to add two different explanation sections: