search

tecosaur / org-latex-preview-todos

A tracker for the Org LaTeX Preview effort on https://git.tecosaur.net/tec/org-mode
4 stars 0 forks source link

Rename org-latex-compile to org-latex-compile-async #31

Open karthink opened 5 months ago

karthink commented 5 months ago

Following the discussion in #28 and @yantar92's suggestion, we should rename all the new async functions we've added (that use org-async and will be included in the patch) to have the -async suffix.

Does this mean we should rename org-latex-preview-place to org-latex-preview-place-async too? I'm not inclined to make this change since this function is intended to be part of the Emacs-wide API for LaTeX previews. Plus, the workhorse org-latex-preview--create-image-async is already named appropriately.

yantar92 commented 5 months ago

karthink @.***> writes:

Following the discussion in #28 and @yantar92's suggestion, we should rename all the new async functions we've added (that use org-async and will be included in the patch) to have the -async suffix.

Does this mean we should rename org-latex-preview-place to org-latex-preview-place-async too? I'm not inclined to make this change since this function is intended to be part of the Emacs-wide API for LaTeX previews. Plus, the workhorse org-latex-preview--create-image-async is already named appropriately.

You don't need to. We only need to take care about preserving the behavior of previously defined functions, so that no third-party code is broken. Newly introduced functions are not constrained.

-- Ihor Radchenko // yantar92, Org mode contributor, 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

karthink commented 4 months ago

Newly introduced functions are not constrained.

I understand. The question about renaming org-latex-preview-place was only to ensure future consistency, not for backwards compatibility.