Project

General

Profile

Task #2202

stop using cute abbreviations in help files

Added by Chris Neale about 2 years ago. Updated about 2 years ago.

Status:
Closed
Priority:
Low
Assignee:
Category:
-
Target version:
Difficulty:
uncategorized
Close

Description

For example, gmx traj has the text "-[no]mol Index contains molecule numbers iso atom numbers" where I guess iso means instead of.

Hard enough for anyone to figure out if they have not encountered it before. Basically impossible for people less familiar with the english language. We should use full words that can be looked up in a dictionary wherever possible.

This text exists in 5.1.2 and also a recent git pull.

Associated revisions

Revision 043bc715 (diff)
Added by Berk Hess about 2 years ago

Replace iso by instead of

Replaced "iso" by "instead of" in all user-facing text.

Fixes #2202.

Change-Id: I126b5d06bb933d68c22faae3b8f39de38b704b78

History

#1 Updated by Berk Hess about 2 years ago

  • Tracker changed from Feature to Task
  • Status changed from New to Accepted

Agreed (I wasn't aware iso was used in user facing text).
I found "iso" also in gmx_hbond and gmx_cluster.
Are there more cute abbreviations?

#2 Updated by Justin Lemkul about 2 years ago

There is another in a fatal error about .hdb files:

gmxpreprocess/h_db.cpp: gmx_fatal(FARGS, "Error in hdb file %s:\nWrong number of control atoms (%d iso %d) on line:\n%s\n", fn, hack->nctl, ncontrol[hack->tp], line);

#3 Updated by Gerrit Code Review Bot about 2 years ago

Gerrit received a related patchset '1' for Issue #2202.
Uploader: Berk Hess ()
Change-Id: gromacs~master~I126b5d06bb933d68c22faae3b8f39de38b704b78
Gerrit URL: https://gerrit.gromacs.org/6695

#4 Updated by Berk Hess about 2 years ago

  • Status changed from Accepted to Fix uploaded
  • Assignee set to Berk Hess
  • Target version set to 2018

Yes, a proper grep also gave that one.
I fixed them all now.

#5 Updated by Berk Hess about 2 years ago

  • Status changed from Fix uploaded to Resolved

#6 Updated by Mark Abraham about 2 years ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF