Project

General

Profile

Actions

Documentation #46365

closed

Developer Guide: prefer Latinate verbs to English phrasal verbs (s/show up/appear/)

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

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

100%

Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:

Description

https://docs.ceph.com/docs/master/dev/developer_guide/basic-workflow/

Here is the sentence that made me raise this Docs Bug:

In short, if your GitHub username is “mygithubaccount”, your fork of the upstream repo will show up at https://github.com/mygithubaccount/ceph.

In speech and in many contexts outside of technical writing, I like Anglo-Saxon phrasal verbs like "show up". However, when writing technical documentation for an international audience that doesn't necessarily have English as its native language, comprehension of phrasal verbs like "to show up" is less likely than the equivalent Latinate single-word (non-phrasal) verb "to appear".

Actions

Also available in: Atom PDF