Skip to content

ogma-core: Documentation refers to wrong system #176

@ivanperez-keera

Description

@ivanperez-keera

Description

The documentation of ogma-core/src/Language/Trans/SMV2Copilot.hs does not refer to the boolean expressions as those in the SMV language, but incorrectly refers to them as FRET expressions, which was old documentation left over after renaming the module.

Type

  • Bug: incorrect documentation.

Additional context

None.

Requester

  • Ivan Perez.

Method to check presence of bug

The output of the following command should be empty:

$ grep -nHire 'fret' ogma-core/src/Language/Trans/SMV2Copilot.hs

It instead lists a number of occurrences.

Expected result

The module should refer to the expressions as SMV boolean expressions.

Desired result

The module should refer to the expressions as SMV boolean expressions.

Proposed solution

Rename all instances of FRET to SMV in ogma-core/src/Language/Trans/SMV2Copilot.hs.

Further notes

None.

Metadata

Metadata

Labels

CR:Status:ClosedAdmin only: Change request that has been completedCR:Type:BugAdmin only: Change request pertaining to error detected

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions