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

Fix OneElement constructor docstring #386

Merged
merged 1 commit into from
Aug 26, 2024
Merged

Conversation

gdalle
Copy link
Contributor

@gdalle gdalle commented Aug 26, 2024

Remove val from a constructor docstring where it doesn't belong

@jishnub
Copy link
Member

jishnub commented Aug 26, 2024

Probably this should be an optional argument? The following does work:

julia> OneElement{Float64}(2, 2, 2)
2-element OneElement{Float64, 1, Tuple{Int64}, Tuple{Base.OneTo{Int64}}}:
   
 2.0

@gdalle
Copy link
Contributor Author

gdalle commented Aug 26, 2024

But then it doesn't belong in the docstring which describes a use without val, and sits above the corresponding function?

@jishnub
Copy link
Member

jishnub commented Aug 26, 2024

Right, this seems fine as such.

Copy link

codecov bot commented Aug 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.90%. Comparing base (9868632) to head (7018312).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #386   +/-   ##
=======================================
  Coverage   99.90%   99.90%           
=======================================
  Files           8        8           
  Lines        1110     1110           
=======================================
  Hits         1109     1109           
  Misses          1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jishnub jishnub merged commit 05b76ad into JuliaArrays:master Aug 26, 2024
22 checks passed
@gdalle gdalle deleted the gd/doc branch August 26, 2024 12:01
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.

2 participants