From: Emily Shaffer <emilyshaffer@google.com>
To: Heba Waly via GitGitGadget <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Heba Waly <heba.waly@gmail.com>,
Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH 1/1] documentation: remove empty doc files
Date: Tue, 22 Oct 2019 14:04:58 -0700 [thread overview]
Message-ID: <20191022210458.GE9323@google.com> (raw)
In-Reply-To: <ffdde613d8ea2dc57719594aa0f89b6d6177b636.1571768375.git.gitgitgadget@gmail.com>
On Tue, Oct 22, 2019 at 06:19:35PM +0000, Heba Waly via GitGitGadget wrote:
> From: Heba Waly <heba.waly@gmail.com>
>
> Remove empty and redundant documentation files from the
> Documentation/technical/ directory.
>
> As part of moving the documentation from Documentation/technical/api-* to
> header files, the following files are deleted because they include only
> TODO messages with no documentation to be moved:
> Documentation/technical/api-grep.txt
> Documentation/technical/api-object-access.txt
> Documentation/technical/api-quote.txt
> Documentation/technical/api-xdiff-interface.txt
Same thing as I mentioned in your other review; what you've added to
your commit message now doesn't say anything you didn't say with the
diff. I can see that you removed empty documentation files; I can see
that those files include only TODO.
Maybe you can explain why it's a bad developer experience to stumble
across these, and that those files sat untouched for years in the
TODO(contributor-name) state.
>
> Signed-off-by: Heba Waly <heba.waly@gmail.com>
> ---
> Documentation/technical/api-grep.txt | 8 --------
> Documentation/technical/api-object-access.txt | 15 ---------------
> Documentation/technical/api-quote.txt | 10 ----------
> Documentation/technical/api-xdiff-interface.txt | 7 -------
> 4 files changed, 40 deletions(-)
> delete mode 100644 Documentation/technical/api-grep.txt
> delete mode 100644 Documentation/technical/api-object-access.txt
> delete mode 100644 Documentation/technical/api-quote.txt
> delete mode 100644 Documentation/technical/api-xdiff-interface.txt
As for the content of this change, I absolutely approve. I've stumbled
across some of these empty docs while looking for answers before and
found it really demoralizing - the community is so interested in
teaching me how to contribute that they've sat on a TODO for 12 years?
:( I even held up api-grep.txt as a (bad) example in a talk I gave this
year. I'm happy to see these files go.
- Emily
next prev parent reply other threads:[~2019-10-22 21:05 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-22 18:19 [PATCH 0/1] [Outreachy] documentation: remove empty doc files Heba Waly via GitGitGadget
2019-10-22 18:19 ` [PATCH 1/1] " Heba Waly via GitGitGadget
2019-10-22 21:04 ` Emily Shaffer [this message]
2019-10-22 23:51 ` Junio C Hamano
2019-10-23 7:23 ` Heba Waly
2019-10-23 7:22 ` Heba Waly
2019-10-23 7:25 ` [PATCH v2 0/1] [Outreachy] " Heba Waly via GitGitGadget
2019-10-23 7:25 ` [PATCH v2 1/1] " Heba Waly via GitGitGadget
2019-10-23 21:44 ` Emily Shaffer
2019-10-24 10:43 ` Heba Waly
2019-10-24 11:29 ` [PATCH v3 0/1] [Outreachy] " Heba Waly via GitGitGadget
2019-10-24 11:29 ` [PATCH v3 1/1] " Heba Waly via GitGitGadget
2019-10-24 20:48 ` Emily Shaffer
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191022210458.GE9323@google.com \
--to=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=heba.waly@gmail.com \
/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.
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 NNTP newsgroup(s).