Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ogma-core: Correct name in documentation. Refs #176. #177

Merged
merged 2 commits into from
Nov 22, 2024

Conversation

ivanperez-keera
Copy link
Member

@ivanperez-keera ivanperez-keera commented Nov 22, 2024

Rename module documentation to refer to SMV, as prescribed in the solution proposed for #176.

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.

This commit renames all occurrences to SMV in the module documentation.
@ivanperez-keera
Copy link
Member Author

Change Manager: Verified that:

  • Solution is implemented:
    • The code proposed compiles and passes all tests. Details:
    • The solution proposed produces the expected result. Details:
      The following dockerfile checks that the module does not contain any outdated references, after which it prints the message "Success":
      FROM ubuntu:focal
      
      RUN apt-get update
      
      RUN apt-get install --yes git
      
      SHELL ["/bin/bash", "-c"]
      CMD git clone $REPO \
          && cd $NAME \
          && git checkout $COMMIT \
          && ! grep -niHre 'fret' ogma-core/src/Language/Trans/SMV2Copilot.hs \
          && echo "Success"
      Command (substitute variables based on new path after merge):
      $ docker run -e "REPO=https://github.com/ivanperez-keera/ogma" -e "NAME=ogma" -e "PAT=ogma"  -e "COMMIT=5092faf6fbf346b9d5ad59aa0c9c7553f76c1410" -it ogma-verify-176
      
  • Implementation is documented. Details:
    Change is to the documentation.
  • Change history is clear.
  • Commit messages are clear.
  • Changelogs are updated.
  • Examples are updated. Details:
    No updates needed; change is in module documentation.
  • Required version bumps are evaluated. Details:
    No bumps needed; change is in module documentation.

@ivanperez-keera ivanperez-keera merged commit fef8303 into nasa:develop Nov 22, 2024
2 checks passed
@ivanperez-keera ivanperez-keera deleted the develop-doc-smv branch November 22, 2024 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant