Project

General

Profile

Actions

Bug #46363

closed

Unusual use of "guidance" on "Essentials" in the Developer Guide

Added by Zac Dover almost 4 years ago. Updated almost 4 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
-
Target version:
-
% Done:

0%

Source:
Tags:
Backport:
Regression:
No
Severity:
3 - minor
Reviewed:
12/07/2020
Affected Versions:
ceph-qa-suite:
Pull request ID:
Crash signature (v1):
Crash signature (v2):

Description

https://docs.ceph.com/docs/master/dev/developer_guide/essentials/

This page contains this sentence:

If your patches emit messages to the Ceph cluster log, please consult this guidance:

The meaning is clear, but this just isn't a place where any elegant speaker of English would use the word "guidance". On first blush, I suggest changing it to "guide", but when I look at it with fresh eyes I will weigh in on the matter again.

Another possible approach that would improve this sentence is the following:

If your patches emit messages to the Ceph cluster log, please consult this:

Anyway, after this much text in this bug report, this probably constitutes overthinking the matter.

Actions #1

Updated by Zac Dover almost 4 years ago

  • Project changed from RADOS to Ceph
Actions #2

Updated by Zac Dover almost 4 years ago

  • Status changed from New to In Progress
  • Pull request ID set to 36072
Actions #3

Updated by Zac Dover almost 4 years ago

  • Status changed from In Progress to Resolved
  • Reviewed set to 12/07/2020
Actions

Also available in: Atom PDF