Skip to content

Consensus on mf-prefixed class names #2243

@martclanor

Description

@martclanor

This concerns all class names prefixed with MF or Mf.

While poking around, I tried using MFSimulationList class, but that apparently doesn't exist because it is instead called MfSimulationList which I thought is a bit unexpected. So I checked to see where MF or Mf is used as a prefix and it seems like there is a pattern, but just almost.

Within flopy/mf6, everything is using MF (e.g. MFDataException, MFBlock, MFTransient, etc.), except for MfGrdFile, MfSimulationList and Mf6Splitter. Elsewhere, Mf is used (e.g. as found in flopy/mfusg and flopy/utils: MfUsg, MfList, Mf6Obs, etc.).

My questions:

  1. First of all, is this inconsistent at all, or did I maybe just miss a different intended pattern?
  2. If it's indeed inconsistent and if this is worth a clean-up, can I simply keep all the mf-prefixed classes in flopy/mf6 with MF?
  3. If not, how exactly do we go about this?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions