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

Improve Documentation #43

Merged
merged 2 commits into from
Jul 2, 2021
Merged

Improve Documentation #43

merged 2 commits into from
Jul 2, 2021

Conversation

tri-adam
Copy link
Member

Improve siftool documentation by adding Long descriptions (used unconditionally by singularity), and improving consistency of terminology across commands.

@tri-adam tri-adam self-assigned this Jun 30, 2021
@codecov-commenter
Copy link

codecov-commenter commented Jun 30, 2021

Codecov Report

Merging #43 (cc04e26) into master (66d2e60) will increase coverage by 0.57%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #43      +/-   ##
==========================================
+ Coverage   66.50%   67.08%   +0.57%     
==========================================
  Files          25       25              
  Lines        1651     1680      +29     
==========================================
+ Hits         1098     1127      +29     
+ Misses        362      361       -1     
- Partials      191      192       +1     
Impacted Files Coverage Δ
pkg/siftool/add.go 62.83% <100.00%> (+3.60%) ⬆️
pkg/siftool/del.go 83.33% <100.00%> (+3.33%) ⬆️
pkg/siftool/dump.go 83.33% <100.00%> (+3.33%) ⬆️
pkg/siftool/header.go 100.00% <100.00%> (ø)
pkg/siftool/info.go 83.33% <100.00%> (+3.33%) ⬆️
pkg/siftool/list.go 100.00% <100.00%> (ø)
pkg/siftool/new.go 100.00% <100.00%> (ø)
pkg/siftool/setprim.go 83.33% <100.00%> (+3.33%) ⬆️
pkg/siftool/siftool.go 91.66% <100.00%> (+2.19%) ⬆️

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 66d2e60...cc04e26. Read the comment docs.

@tri-adam tri-adam marked this pull request as ready for review June 30, 2021 23:02
Copy link
Member

@dtrudg dtrudg left a comment

Choose a reason for hiding this comment

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

LGTM

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.

3 participants