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

Align INI File Comment Syntax with Common Standards: Replace // with ; #549

Open
2 tasks
suzuki-toshihir0 opened this issue Nov 16, 2023 · 1 comment
Open
2 tasks
Labels
minor update add functionality in a backwards compatible manner priority::medium priority medium simulation simulation settings

Comments

@suzuki-toshihir0
Copy link
Member

suzuki-toshihir0 commented Nov 16, 2023

Details

  • Currently, the INI files in S2E use // to denote comments. However, as per the INI file standards, it is more common to use ; at the beginning of a comment line.
  • There are hardly any other examples of INI files that recognize // as a comment, which is confusing, so I would like to conform to the ; style.
  • This becomes problematic when using libraries such as configparser in Python for post-analysis of simulation results. The library expects ; to start comment lines and fails to parse files commented with //.

Closing conditions

  • All existing INI files in the repository have been updated to use ; for comments.
  • In the future, I want to issue warnings for comments starting with //, and eventually treat // comments as errors in a major update.

Supplementary information

NA

Note

  • TBW
@suzuki-toshihir0 suzuki-toshihir0 added priority::medium priority medium simulation simulation settings minor update add functionality in a backwards compatible manner labels Nov 16, 2023
@github-project-automation github-project-automation bot moved this to 🔲 Todo in S2E Nov 16, 2023
@suzuki-toshihir0 suzuki-toshihir0 changed the title [INI] Align INI File Comment Syntax with Common Standards: Replace // with ;" Align INI File Comment Syntax with Common Standards: Replace // with ;" Nov 16, 2023
@suzuki-toshihir0 suzuki-toshihir0 changed the title Align INI File Comment Syntax with Common Standards: Replace // with ;" Align INI File Comment Syntax with Common Standards: Replace // with ; Nov 16, 2023
@200km
Copy link
Member

200km commented Nov 16, 2023

Related issues

#254

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor update add functionality in a backwards compatible manner priority::medium priority medium simulation simulation settings
Projects
Status: 🔲 Todo
Development

No branches or pull requests

2 participants