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

Update documentation for pillarbox-cast #774

Merged
merged 13 commits into from
Nov 1, 2024
Merged

Update documentation for pillarbox-cast #774

merged 13 commits into from
Nov 1, 2024

Conversation

MGaetan89
Copy link
Member

@MGaetan89 MGaetan89 commented Oct 29, 2024 •
edited
Loading

Pull request

Description

Update the documentation for pillarbox-cast.

Changes made

  • Update docs/README.md to work with Dokka (mainly removing images) and improving wording and samples.
  • Remove Module.md.
  • Update the KDoc for every public class/method/interface.

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).

@MGaetan89 MGaetan89 self-assigned this Oct 29, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 29, 2024 •
edited
Loading

Code Coverage

Overall Project 47.73% 🟢
Module Coverage
:pillarbox-cast 0% 🟢
Files
Module File Coverage
:pillarbox-cast CastExtensions.kt 0% 🟢
CastButton.kt 0% 🟢

@MGaetan89 MGaetan89 force-pushed the revisit_analytics_documentation branch from 604c359 to 9f290d9 Compare October 29, 2024 16:26
@MGaetan89
Copy link
Member Author

Converting to draft, until #775 and #770 are merged

@MGaetan89 MGaetan89 marked this pull request as draft October 30, 2024 08:02
@MGaetan89 MGaetan89 force-pushed the revisit_analytics_documentation branch from 817283c to 38fc48d Compare October 31, 2024 12:27
@MGaetan89 MGaetan89 marked this pull request as ready for review October 31, 2024 12:48
@MGaetan89
Copy link
Member Author

Conflicts have been fixed, and the branch has been updated with the latest version of revisit_analytics_documentation

Base automatically changed from revisit_analytics_documentation to main November 1, 2024 16:30
@MGaetan89 MGaetan89 added this pull request to the merge queue Nov 1, 2024
Merged via the queue into main with commit fd8e6c9 Nov 1, 2024
9 checks passed
@MGaetan89 MGaetan89 deleted the revisit_cast_documentation branch November 1, 2024 16:49
@MGaetan89 MGaetan89 linked an issue Nov 3, 2024 that may be closed by this pull request
Provide a consolidated documentation for Pillarbox #762
Open
@MGaetan89 MGaetan89 added the documentation Improvements or additions to documentation label Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@StaehliJ StaehliJ StaehliJ approved these changes

Assignees

@MGaetan89 MGaetan89

Labels
documentation Improvements or additions to documentation
Projects
Pillarbox
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Provide a consolidated documentation for Pillarbox
2 participants
@MGaetan89 @StaehliJ