Skip to content

[Documentation] Reattach the detailed docstring for parseconda - #271

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

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

Conversation

@sotashimozono

Copy link
Copy Markdown

This is a trivial documentation issue. The detailed docstring for parseconda is followed by a blank line and a second, one-line docstring, so only the one-liner is attached and the detailed text is discarded.

Julia binds a string literal to the immediately following expression, and the manual notes that no blank lines or comments may intervene — so the first """...""" here documents nothing.

Removing the shadowing one-liner restores the detailed version. Unlike the other packages I checked this way, I could not verify this by loading, since Conda requires Pkg.build; the change is structural (the detector that found it no longer flags the site).

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-commenter

codecov-commenter commented Aug 27, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.22%. Comparing base (f1f4760) to head (79c5085).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #271   +/-   ##
=======================================
  Coverage   85.22%   85.22%           
=======================================
  Files           1        1           
  Lines         203      203           
=======================================
  Hits          173      173           
  Misses         30       30           

☔ 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.

@sotashimozono sotashimozono changed the title Reattach the detailed docstring for parseconda [Documentation] Reattach the detailed docstring for parseconda Aug 29, 2026
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