Introduce cider-log-show function
#3602
Conversation
This way, users will know logview-mode exists. There's still fallback, and optionality.
vemv
changed the title
cider-log-show function
cider-log.el
Outdated
| @@ -1154,12 +1178,17 @@ the CIDER Inspector and the CIDER stacktrace mode. | |||
| (let ((inhibit-read-only t)) | |||
| (erase-buffer))))) | |||
|
|
|||
| (defun cider-log-switch-to-buffer* (buffer) | |||
There was a problem hiding this comment.
Should we make this private, e.g. use 2 dashes cider-log--switch-to-buffer ?
There was a problem hiding this comment.
Yeah, probably. In general the external API for cider-log should be quite limited.
| @@ -103,6 +145,15 @@ https://stackoverflow.com/a/17842174/12711900[difficulties] with | |||
| configuration changes made at runtime, which are wiped out by the | |||
| Log4j2 reconfiguration mechanism. | |||
|
|
|||
| Timbre support is WIP as well. | |||
|
|
|||
| TIP: If your logging framework of choice is not currently supported by CIDER Log Mode, | |||
|
The changes look good to me overall. |
| session attached to it. The first time you run the command, it will | ||
| To use CIDER Log Mode, there are a few ways to get started: | ||
|
|
||
| * Traditionally, `M-x cider-log` has been considered the main entrypoint, although it can be slightly low-level for casual usage. |
There was a problem hiding this comment.
That's a brand new feature, so I don't think we can talk about "traditional" usage. :-) Let's just focus on the use-cases for each and not on whether something is newer/older.
There was a problem hiding this comment.
I was also thinking this, it's still marked as experimental in the docs.
There was a problem hiding this comment.
As it should be. I don't want to mark it as stable until we've solidified the interface and I want us to have some leeway for breaking changes to get to the optimal interface.
|
My only bigger feedback is that even after reading the docs and knowing what the functions do, I find the differences between You have to understand that most users will have 0 idea what |
|
Thanks folks, all feedback applied. Now there are two documented ways to get started, and one function left as advanced usage in another section. All ideas certainly welcome as for how to further improve workflows. Will be deploying docs in a few minutes. |
|
Nice! Thanks @vemv! |
Rehash of #3592, with misc feedback applied.
My take is summarized in the expanded documentation - there are three approaches, two of which are higher-level and therefore most recommended as an entrypoint to most users.
My thinking is that of the high-level commands, one (
cider-log-show) would never use transient-mode, and the other one (cider-log-event) always would. This way we have predictable UXs for users.Commits:
cider-log-showfunctionHappy new year,
-V