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

Improve style #49

Open
2 of 6 tasks
dietmarw opened this issue Jun 10, 2023 · 0 comments
Open
2 of 6 tasks

Improve style #49

dietmarw opened this issue Jun 10, 2023 · 0 comments
Labels
enhancement New feature or request
Milestone

Comments

@dietmarw
Copy link
Collaborator

dietmarw commented Jun 10, 2023

One thing to still improve (and is a low hanging fruit) would be to fix the issues found when running a style check on the library. I just did those using Dymola 2023x Refresh1 on v1.0.0:
DroneLibrary_StyleCheckLog.html.zip

Now that report is very strict but what should at least be fixed (also when thinking of the library reward) is:

Must

  • "Class description string missing"
  • "Component description string beginning with lower case character for"
  • "Class description string starting with whitespace"

Optional

  • "Documentation missing" (this is quite a big job)
  • "(Possibly) insufficient documentation" (points to an empty html part, so same as above)
  • "Mixing of components and equations" (should be investigated)

Ignore

  • "Bad class name Name of model shall start with capital letter. Name shall not contain '_'." (not ideal but we can probably live with those for now
@dietmarw dietmarw added this to the v1.0.1 milestone Jun 10, 2023
@dietmarw dietmarw added the enhancement New feature or request label Jun 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant