Morgan Smith <[email protected]> writes:
> `org-agenda-log-mode-items' tells us what to display in a log-mode agenda. It
> can be a list containing any combination of clock, state, and closed.
>
> - clock means include any clocking data
> - state means include any state change data
> - has a list item that looks like: - State "x" from "y" <timestamp>
> - closed means include any items with the "CLOSED:" keyword set
>
> The `state' and `closed' have no overlap since they are looking for different
> metadata. I'm ok with the behavior but it is not well documented and should
> be.
What do you mean by "not well-documented"?
> The main issues I have is the behavior caused by
> `org-agenda-start-with-log-mode' (which is very connected to
> `org-agenda-show-log' and `org-agenda-show-log-scoped').
>
> If `org-agenda-start-with-log-mode' is set to a list it completely overrides
> `org-agenda-log-mode-items' which is not documented anywhere.
I think it is documented:
(defcustom org-agenda-start-with-log-mode nil
"The initial value of log-mode in a newly created agenda window.
See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
explanations on the possible values."
The other question is that `org-agenda-log-mode-items' docstring does
not say that it can be overridden by `org-agenda-start-with-log-mode'.
Also, the value of `org-agenda-start-with-log-mode' can be t, which is
not documented.
> ... Furthermore, in
> this case it starts including "scheduled" and "deadline" items!! What!?!?!
> (see attached patch for a fix for that).
Could you please elaborate what exactly you did not expect?
Log mode mixes not-yet-done items with closed items unless explicitly
set to 'only or 'clockcheck. This is intentional.
> 'clockcheck is also the only customization that allows automatically running
> `org-agenda-show-clocking-issues'. We can show clocking issues just fine when
> other items are in the log-mode buffer. I'm quite puzzled as to why
> 'clockcheck overrides the value of `org-agenda-log-mode-items'.
"Just fine" depends on your usage.
When the my whole day is covered by clocking items, mixing them up with
normal todos is disruptive when reviewing the clocking data.
So, no, it is not obvious that mixing things is a good idea.
Some people prefer the existing default, and you seems to want a feature
to mix clockcheck with normal todos.
Do you use clockchecks and clocking often? Or did you just casually play
with the feature and think that the defaults should be changed?
If the former, we can consider adding a new customization as a feature.
> Changes I want to make:
>
> I'm going to say a series of sweeping changes here. Obviously if I where to
> implement them I'd make sure to follow proper deprecation procedure and try
> not
> the break user customizations.
>
> `org-agenda-start-with-log-mode'
> - better documentation
> - change 'only value to t (not sure why it's called only)
Emm. 'only currently limits the display to closed items. t, in contrast,
shows a mix of logs and todos. The proposed change will be breaking.
> - don't allow setting log-mode-items from here (why is this even a thing?)
We cannot just remove this feature. It would be breaking.
Although, we might remove the documentation about it and say in the
docstring that t will follow log-mode-items.
--
Ihor Radchenko // yantar92,
Org mode maintainer,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
