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.

Sign up for GitHub

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

Jump to bottom

ogma-cli: Document format of variable DB. Refs #143. #144

Merged
merged 2 commits into from
May 22, 2024
Merged

ogma-cli: Document format of variable DB. Refs #143. #144

merged 2 commits into from
May 22, 2024

Conversation

ivanperez-keera
Copy link
Member

Document, in the README, the format of the variables DB file, as prescribed in the solution proposed for #143.

@ivanperez-keera
ogma-cli: Document format of variable DB. Refs #143.
9e4b4c1 
The README does not explain the structure that the variable DB files for
ROS should have. Because ogma doesn't give much information to users
when a variable cannot be found in the var DB, users do not know what to
put in each field in the variable DB, and what effect it will have in
the program.

This commit adds a subsection to the ROS section of the README
explaining the structure and format of the variable DB.
@ivanperez-keera
ogma-cli: Document changes in CHANGELOG. Refs #143.
ab8e8ac
@ivanperez-keera
Copy link
Member Author

Change Manager: Verified that:

@ivanperez-keera ivanperez-keera merged commit 7bfce11 into develop May 22, 2024
4 checks passed
@ivanperez-keera ivanperez-keera deleted the develop-readme-varDB branch May 22, 2024 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ivanperez-keera