Hello,

I recently started looking at the org-set-tags function in org.el, but then
quickly got confused with the doc-string.

  "Set the tags for the current headline.
With prefix ARG, realign all tags in headings in the current buffer.
When JUST-ALIGN is non-nil, only align tags."

The purpose of ARG and JUST-ALIGN seems to be the exact same from the
doc-string. On reading the code, I realized that actually ARG should have
been called JUST-ALIGN and the JUST-ALIGN should have been called
ALIGN-ONLY-CURRENT.

The attached patch contains the updated doc-string, refactoring of the
argument names, and renaming of the argument symbol to :align-only-current
from 'align and 'ignore-column in org-set-tag calls. I have left most of
the org-set-tags calls untouched where the argument values are simply t
instead of descriptive 'align or 'ignore-column.

As the patch introduces no functional changes, I have based it off maint.
"make test" is still passing with these changes.

Can you please review the patch and let me know if it's good for committing?

Thanks.
-- 

Kaushal Modi

Attachment: 0001-Clarify-the-purpose-of-org-set-tags-arguments.patch
Description: Binary data

Reply via email to