Skip to content

Inconsistent Terminology (SIPNET vs Sipnet) #212

@ayushman1210

Description

@ayushman1210

DESCRIPTION

The repository currently uses inconsistent capitalization when referring to the model name in documentation and source code comments. The model is variously referred to as SIPNET (all caps) and Sipnet (sentence case).

Identified Inconsistencies:

  • Documentation Titles: The primary README.md and CHANGELOG.md use "SIPNET" in headers and titles.
  • Source Code Comments: In src/sipnet/sipnet.c, the file header begins with "SiPnET: Simplified PnET" but then switches to "SIPNET" in subsequent comments.
  • User Guides: The user guide files (e.g., running-sipnet.md) frequently use "sipnet" (lowercase) when referring to the executable, but "Sipnet" or "SIPNET" when referring to the model itself.
  • Infrastructure Files: The wish-list.md uses "SIPNET WISH LIST" in the main title but "sipnet.in" for the configuration file, which is technically correct for filenames but contributes to the visual inconsistency in text blocks.

I am happy to submit a pr if this issue accepted

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions