open-dis-python icon indicating copy to clipboard operation
open-dis-python copied to clipboard

Inconsistent naming for attributes representing a count

Open ngjunsiang opened this issue 1 year ago • 0 comments

numberOf* vs *Count

In the PDF specification, the two terms are used interchangeably. However, when programming, it is helpful to establish a consistent naming convention so that programmers do not need to keep looking up the attribute names.

There are currently two ways of naming values that represent the count/number of records or values:

https://github.com/open-dis/open-dis-python/blob/9312cb2cf915b1282d0771db92047c19ecd5f91f/opendis/dis7.py#L48-L49

vs

https://github.com/open-dis/open-dis-python/blob/9312cb2cf915b1282d0771db92047c19ecd5f91f/opendis/dis7.py#L537

Pros and cons

Pros of numberOf* naming

  • ???

Pros of *Count naming

  • convenient visual alignment (fixedDatumIDs and fixedDatumIDCount will left-align for easier visual identification when browsing code)
  • shorter attribute names

This is admittedly a minor issue and might not affect many users, though it's clear where my biases lie. Currently it's a minor speedbump for my work on the repo, and I can wait for a resolution on (a) whether consistent naming would be beneficial, (b) which naming convention to go with.

ngjunsiang avatar May 16 '24 14:05 ngjunsiang