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

Add YARD documentation to release-toolkit actions #192

Open
10 tasks
AliSoftware opened this issue Jan 18, 2021 · 0 comments
Open
10 tasks

Add YARD documentation to release-toolkit actions #192

AliSoftware opened this issue Jan 18, 2021 · 0 comments

Comments

@AliSoftware
Copy link
Contributor

AliSoftware commented Jan 18, 2021

Add YARD documentation to all the methods in release-toolkit, especially the methods on actions and helpers.

Part of this task will likely be tackled in parallel to the code rearrangement / refactoring in #191 – as we plan to write YARD documentation for new code as it is being refactored / rewritten. But this issue will cover more than #191 as we need to also document even code that won't really need to change / be refactored.

  • Helpers
    • *_version_helper iOS + Android (🚧 WIP)
    • *_git_helper iOS + Android (🚧 WIP)
    • Other iOS helpers (🚧 WIP)
    • Common (non-platform-specific) helpers
  • Actions
    • Android actions
    • iOS Actions
    • Common Actions
    • Configure Actions
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

No branches or pull requests

1 participant