Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improves the API doc for renderIf #911

Merged
merged 2 commits into from
Oct 22, 2024
Merged

Conversation

Lysander
Copy link
Collaborator

Improves the API doc for renderIf

The pimped `className`-function (introduced by PR #823 in `1.0-RC15` release) did not apply exception handling. That could lead to errors,
if there is code that removes some element:

The independent reactive renderings could simply lead to corner cases,
where a lens will try to access its mapped object (e.g. by `mapByElement`)
that is no longer part of the stored model. So a
`CollectionLensGetException` will be thrown and must be handled by the
consuming code.

This PR adds such exception handling code and a unit test to verify
the new, correct behaviour.
@Lysander Lysander added the documentation Improvements or additions to documentation label Oct 21, 2024
@Lysander Lysander added this to the 1.0-RC20 milestone Oct 21, 2024
@Lysander Lysander requested a review from haukesomm October 21, 2024 11:43
@Lysander Lysander self-assigned this Oct 21, 2024
@Lysander Lysander force-pushed the chausknecht/improve-renderif-kdoc branch from 32ac7b2 to 131507d Compare October 21, 2024 15:36
@Lysander Lysander requested a review from haukesomm October 21, 2024 15:37
@Lysander Lysander merged commit 9cfe5d0 into master Oct 22, 2024
2 checks passed
@Lysander Lysander deleted the chausknecht/improve-renderif-kdoc branch October 22, 2024 07:48
Lysander added a commit that referenced this pull request Oct 22, 2024
Improves the API doc for `renderIf`

---------

Co-authored-by: christian.hausknecht <christian.hausknecht@oeffentliche.de>
(cherry picked from commit 9cfe5d0)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants