[inspector] Add refresh to replace individual set-* functions
#269
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alexander-yakushev
force-pushed
the
set-config
branch
from
5d26bbb to
cc04e2b
Compare
vemv
approved these changes
May 14, 2024
src/orchard/inspect.clj
Outdated
| (defn ^:deprecated set-page-size | ||
| "Use `set-config` instead." | ||
| [inspector new-page-size] | ||
| (set-config inspector {:page-size new-page-size})) |
There was a problem hiding this comment.
From this usage it looks like set-config should be named merge-config instead? Else it looks as if {:page-size new-page-size} would override everything
(or render-merged-config, IDK)
There was a problem hiding this comment.
Yeah, I'm struggling with the name. Just merge-config doesn't imply that the inspector "refreshes". render-merged-config is a bit clunky for a public function. I initially went with refresh but that doesn't highlight enough that config can be changed.
There was a problem hiding this comment.
Maybe something like (defn refresh [inspector config-override])?
There was a problem hiding this comment.
SGTM, savvy users most certainly should be using CIDER to take a look at the arglists :)
alexander-yakushev
force-pushed
the
set-config
branch
from
cc04e2b to
44883ab
Compare
alexander-yakushev
changed the title
refresh to replace individual set-* functions
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, each config value has its own public setter with lots of repeatable code, room for error when copy-pasting, and spread documentation. Those setters are also not used when the inspector is started, so the validation does not work in that case.
This is me trying to wrangle this, to reduce the API surface, and to unify configuration between starting an inspector and changing the config in an existing one.
All existing functions are retained for compatibility and marked as deprecated.