Opened 12 months ago

Last modified 7 months ago

#1059 assigned defect

Remove camel case from unified_power_Rg

Reported by: smk78 Owned by: butler
Priority: minor Milestone: SasView 4.3.0
Component: SasView Keywords:
Cc: Work Package: SasView Bug Fixing

Description

@llimeht points out in SasView PR 137 that unified_power_Rg contains capitalisation (in contravention of the agreed coding rules) meaning links to the corresponding help documentation are not working.

Though the PR removes case dependency, the expedient approach is also to enforce the coding standard. Thus the model should be renamed and links to the doc pages checked.

Change History (6)

comment:1 Changed 12 months ago by pkienzle

The Rg in this case is not camel case since it is naturally capitalized and is preceded by an underscore. Much like we ignore the PEP 8 rules for case for variable names when matching the math symbols used in a paper, we could claim that this is a legitimate use of an upper case name for a model.

comment:2 Changed 12 months ago by butler

  • Owner set to butler
  • Status changed from new to assigned

comment:3 Changed 12 months ago by butler

True but the rule was "no capitalization" not "no camel case". The later is a result of the first. Relevant section reads:

Please follow these new naming rules:

* No capitalization and thus no CamelCase. If necessary use underscore to separate (i.e. barbell not BarBell or broad_peak not BroadPeak)
* Remove “model” from the name (i.e. barbell not BarBellModel)

comment:4 Changed 12 months ago by butler

  • Priority changed from blocker to major

comment:5 Changed 10 months ago by butler

  • Priority changed from major to minor

comment:6 Changed 7 months ago by butler

  • Milestone changed from SasView 4.2.0 to SasView 4.3.0

Probably cannot be done for this release so moving to 4.3

Note: See TracTickets for help on using tickets.