unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Karl Fogel <kfogel@red-bean.com>
To: Emacs Devel <emacs-devel@gnu.org>
Subject: What's the right branch for doc string typo fixes right now?
Date: Wed, 16 Nov 2022 11:48:38 -0600	[thread overview]
Message-ID: <87ilje4wp5.fsf@red-bean.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 805 bytes --]

I'd like to commit the attached patch, which fixes a couple of 
typos in a doc string.  What's the right branch for this?

Ordinarily I would think 'emacs-28', based on this from 
CONTRIBUTE:

> Documentation fixes (in doc strings, in manuals, in NEWS, and in
> comments) should always go to the release branch, if the 
> documentation
> to be fixed exists and is relevant to the release-branch 
> codebase.
> Doc fixes are always considered "safe" -- even when a release 
> branch
> is in feature freeze, it can still receive doc fixes.  However, 
> this
> rule is limited to fixing real problems in the documentation; 
> cleanups
> and stylistic changes are excluded.

However, the last sentence of that paragraph implies that maybe 
this should go on 'master' instead of on 'emacs-28'?

Thanks, -Karl


[-- Attachment #2: bookmark-typo-fix.txt --]
[-- Type: text/plain, Size: 680 bytes --]

[[[
Fix two typos in a doc string
]]]

diff --git lisp/bookmark.el lisp/bookmark.el
index b57ad12986..15e7273f91 100644
--- lisp/bookmark.el
+++ lisp/bookmark.el
@@ -365,8 +365,8 @@ bookmark-name-from-full-record
   (car bookmark-record))
 
 (defun bookmark-type-from-full-record (bookmark-record)
-  "Return then type of BOOKMARK-RECORD.
-BOOKMARK-RECORD is, e.g., one element from `bookmark-alist'. It's
+  "Return the type of BOOKMARK-RECORD.
+BOOKMARK-RECORD is, e.g., one element from `bookmark-alist'.  Its
 type is read from the symbol property named
 `bookmark-handler-type' read on the record handler function."
   (let ((handler (bookmark-get-handler bookmark-record)))

             reply	other threads:[~2022-11-16 17:48 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-16 17:48 Karl Fogel [this message]
2022-11-16 19:36 ` What's the right branch for doc string typo fixes right now? Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87ilje4wp5.fsf@red-bean.com \
    --to=kfogel@red-bean.com \
    --cc=emacs-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).