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

Adds additional documentation to README.md #63

Merged
merged 9 commits into from
May 6, 2022
Merged

Conversation

dlurton
Copy link
Contributor

@dlurton dlurton commented Jan 28, 2022

Improves README.md quite a bit. Now finished.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@dlurton dlurton marked this pull request as draft January 28, 2022 21:42
Copy link
Contributor Author

@dlurton dlurton left a comment

Choose a reason for hiding this comment

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

"Are there any cases where a user should choose to use IonValue over IonElement?"

@codecov-commenter
Copy link

codecov-commenter commented Feb 24, 2022

Codecov Report

Merging #63 (5dc3bcf) into master (8845767) will increase coverage by 0.08%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master      #63      +/-   ##
============================================
+ Coverage     86.70%   86.79%   +0.08%     
- Complexity      368      370       +2     
============================================
  Files            30       30              
  Lines           737      742       +5     
  Branches         72       72              
============================================
+ Hits            639      644       +5     
  Misses           65       65              
  Partials         33       33              
Impacted Files Coverage Δ
src/com/amazon/ionelement/api/IonUtils.kt 100.00% <0.00%> (ø)

Continue to review full report at Codecov.

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

@dlurton dlurton changed the title Greatly improve README.md (work in progress) Greatly improve README.md Feb 24, 2022
@dlurton dlurton marked this pull request as ready for review February 24, 2022 22:41
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
tgregg
tgregg previously approved these changes May 6, 2022
Copy link
Contributor

@tgregg tgregg left a comment

Choose a reason for hiding this comment

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

Great documentation

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Tyler Gregg <tgregg@users.noreply.github.com>
@popematt popematt changed the title Greatly improve README.md Adds additional documentation to README.md May 6, 2022
@popematt popematt merged commit ef0fb5e into master May 6, 2022
@popematt popematt linked an issue May 12, 2022 that may be closed by this pull request
@popematt popematt mentioned this pull request Jun 9, 2022
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

Successfully merging this pull request may close these issues.

Add this documentation snippet about using the narrowing APIs.
4 participants