Skip to content

Reattach the docstring for Future.abs2 - #204

Open
sotashimozono wants to merge 1 commit into
JuliaGraphics:masterfrom
sotashimozono:reattach-docstring
Open

Reattach the docstring for Future.abs2#204
sotashimozono wants to merge 1 commit into
JuliaGraphics:masterfrom
sotashimozono:reattach-docstring

Conversation

@sotashimozono

Copy link
Copy Markdown

This is a trivial documentation issue. The docstring for ColorVectorSpace.Future.abs2 is separated from the definition by a blank line and an intervening if VERSION block, so it is never attached.

julia> using ColorVectorSpace   # v0.11.0

julia> F = ColorVectorSpace.Future;

julia> haskey(Base.Docs.meta(F), Base.Docs.Binding(F, :abs2))
false

Moving the docstring down to function abs2 restores it. Julia binds a string literal to the immediately following expression, and the manual notes that no blank lines or comments may intervene.

A comment or blank line between the docstring and the definition stops
Julia from attaching it, so the documentation is silently dropped.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@codecov

codecov Bot commented Aug 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.33%. Comparing base (028a3f0) to head (5612e74).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #204   +/-   ##
=======================================
  Coverage   85.33%   85.33%           
=======================================
  Files           3        3           
  Lines         266      266           
=======================================
  Hits          227      227           
  Misses         39       39           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

1 participant