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

Polish implementation and documentation #814

Merged
merged 7 commits into from
Apr 2, 2024
Merged

Polish implementation and documentation #814

merged 7 commits into from
Apr 2, 2024

Conversation

defagos
Copy link
Member

@defagos defagos commented Apr 2, 2024

Description

This PR proposes a few minor implementation and documentation improvements found randomly when looking at the code.

Changes made

  • Fix documentation issues.
  • Remove the Internal folder that was not contributing much to the project structure.
  • Improve CommandersActService.start(with:) implementation to avoid early return. The optional binding is an artifact of lacking nullability in Commanders Act headers, we should never skip what's next. We could also replace the optional binding with a force unwrap in this case but there is not much to gain IMHO.
  • Improve code consistency.

Checklist

  • APIs have been properly documented (if relevant).
  • The documentation has been updated (if relevant).
  • New unit tests have been written (if relevant).
  • The demo has been updated (if relevant).

@defagos defagos self-assigned this Apr 2, 2024
@defagos defagos enabled auto-merge April 2, 2024 05:20
@defagos defagos added the enhancement New feature or request label Apr 2, 2024
@defagos defagos added this pull request to the merge queue Apr 2, 2024
Merged via the queue into main with commit 3e4ff5e Apr 2, 2024
6 checks passed
@defagos defagos deleted the polishing branch April 2, 2024 08:04
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
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants