[Pulp-dev] sync abbreviations

Jeff Ortel jortel at redhat.com
Tue Jun 27 17:17:15 UTC 2017


For the most part, I have mixed feelings about abbreviated words in code.  On one hand I value being concise
but also value clarity.

With this in mind, I propose we stop abbreviating `synchronize` in code and documentation.  It seems unnecessary.

Example:

Importer.sync()
-to-
Importer.synchronize()

and

Importer.last_sync
-to-
Importer.last_synchronized.

In documentation:

"The importer will perform a sync operation on the repository"
-to-
"The importer will synchronize the repository"

"The importer will log errors during sync"
-to-
"The importer will log synchronization errors"


This also has better symmetry with "publish".  We don't abbreviate as "pub".


I know it's pedantic but ...


Thoughts?

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 847 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/pulp-dev/attachments/20170627/ff4f0583/attachment.sig>


More information about the Pulp-dev mailing list