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

Update Documentation in Conformance to the Documentation Guide #14

Merged
merged 8 commits into from
Oct 8, 2023

Conversation

vishnuravi
Copy link
Member

Update Documentation in Conformance to the Documentation Guide

♻️ Current situation & Problem

Addresses issue #11.

📝 Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

@codecov
Copy link

codecov bot commented Sep 21, 2023

Codecov Report

Merging #14 (0e0ef1a) into main (739ee1e) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #14   +/-   ##
=======================================
  Coverage   91.65%   91.65%           
=======================================
  Files           6        6           
  Lines         431      431           
=======================================
  Hits          395      395           
  Misses         36       36           
Files Coverage Δ
Sources/SpeziLocalStorage/LocalStorage.swift 89.43% <ø> (ø)
...ources/SpeziLocalStorage/LocalStorageSetting.swift 97.30% <ø> (ø)
Sources/SpeziSecureStorage/Credentials.swift 100.00% <ø> (ø)
Sources/SpeziSecureStorage/SecureStorage.swift 93.34% <ø> (ø)
...ources/SpeziSecureStorage/SecureStorageScope.swift 82.46% <ø> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 739ee1e...0e0ef1a. Read the comment docs.

Copy link
Member

@PSchmiedmayer PSchmiedmayer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR and nice documentation improvements @vishnuravi!

I updated the documentation in multiple places to unify it and improve it along the way, you can see this in the following commit: 0e0ef1a

Feel free to merge the PR once you are happy with all the changes 🚀

@vishnuravi
Copy link
Member Author

Thank you for the PR and nice documentation improvements @vishnuravi!

I updated the documentation in multiple places to unify it and improve it along the way, you can see this in the following commit: 0e0ef1a

Feel free to merge the PR once you are happy with all the changes 🚀

Great, thank you @PSchmiedmayer!

@vishnuravi vishnuravi merged commit 58f79a2 into main Oct 8, 2023
7 checks passed
@vishnuravi vishnuravi deleted the documentation branch October 8, 2023 19:17
@PSchmiedmayer PSchmiedmayer added the documentation Improvements or additions to documentation label Oct 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants