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 Examples to Package Documentation #25

Merged
merged 4 commits into from
Jul 20, 2021
Merged

Add Examples to Package Documentation #25

merged 4 commits into from
Jul 20, 2021

Conversation

seantan22
Copy link
Contributor

@seantan22 seantan22 commented Jul 19, 2021

Closes #23

Adds functional examples to the slog package documentation.

To Test:

  1. godoc -http=:6060
  2. open http://localhost:6060/pkg/github.com/ParticleHealth/tau/slog/ in browser
  3. view examples

@codecov
Copy link

codecov bot commented Jul 19, 2021

Codecov Report

Merging #25 (fcb57ca) into main (e35c9de) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #25   +/-   ##
=======================================
  Coverage   95.93%   95.93%           
=======================================
  Files           2        2           
  Lines         172      172           
=======================================
  Hits          165      165           
  Misses          3        3           
  Partials        4        4           
Impacted Files Coverage Δ
slog/slog.go 96.85% <ø> (ø)

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 e35c9de...fcb57ca. Read the comment docs.

@seantan22 seantan22 requested review from a user and gmontagu July 19, 2021 19:18
slog/slog_test.go Outdated Show resolved Hide resolved
slog/slog_test.go Outdated Show resolved Hide resolved
@seantan22 seantan22 requested a review from a user July 20, 2021 15:21
@seantan22
Copy link
Contributor Author

@Orbz Updated tests to be more functional -- are there any functions that I've missed that you think I should include examples for?

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

Nice job! Looks great.

slog/example_test.go Outdated Show resolved Hide resolved
slog/example_test.go Show resolved Hide resolved
slog/example_test.go Outdated Show resolved Hide resolved
@seantan22 seantan22 requested a review from a user July 20, 2021 21:48
@seantan22 seantan22 merged commit ceacc05 into main Jul 20, 2021
@seantan22 seantan22 deleted the examples_seantan branch July 20, 2021 23:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Example documentation for slog
1 participant