Repository navigation
docs: fill every stdlib doc-comment gap, fix std explorer's mixed text - #212
Merged
Merged
Conversation
It kept walking through blank lines once it had seen one comment, gluing an unrelated floating banner a few lines above onto a symbol's own doc text - confirmed as 11 real mixed-text cases in the current site. Now stops at the first blank line, matching fls's own doc_comment_above exactly.
Every pub fun/compound/enum/shape, every field, variant, and shape/impl method across stdlib/std now has its own doc comment - confirmed zero gaps left by the real generator's own scan, not an approximation.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #212 +/- ##
=======================================
Coverage 81.59% 81.60%
=======================================
Files 102 102
Lines 41387 41387
=======================================
+ Hits 33771 33774 +3
+ Misses 7616 7613 -3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…wn doc Same bug shape as collectCommentAbove, just scanning downward from the file's top instead of upward from a declaration - confirmed on std.c.atomic.fn, whose module doc ran straight into __fun_atomic_load's own comment. A genuine blank line only ever ends a module comment in this codebase (a paragraph break inside one is always a bare //), so there's no legitimate case the old leniency covered.
…link
Points straight at the real GitHub line, pinned to the v{funVersion} release tag the generated content itself was built from (same convention the existing release-notes link already uses) - so it stays accurate for whichever version a given page is showing, not main, which drifts. Added next to the module header, the active symbol's own header, and every field/member/variant row - everywhere a line number already shows.
position: sticky on the symbol/module tabs hit a genuine WebKit repaint bug - stale content from whatever had scrolled past stayed visible behind them (Chromium was clean at the exact same scroll state, confirmed directly, a translateZ(0) compositing workaround did not fix it either). Restructured so the tabs sit structurally outside the scrolling area instead, the same way the modal header already safely does, removing the sticky positioning entirely rather than chasing the repaint quirk further. Also normalizes the Copy link/View source/Permalink/Close buttons (mixing <a> and <button> under the same class left the anchor taller - no shared display/line-height/font to make them agree) and left-aligns a symbol's own line/View source row under its heading instead of cramming it inline.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
website/reference/scripts/generate-content.mjs): it walked through blank lines once it had seen a comment, gluing an unrelated floating banner a few lines above onto a symbol's own doc text. Now strict, matching fls's owndoc_comment_aboveexactly (stop at the first blank line) - fixes 11 confirmed cases of mixed/garbled text in the current site.std.c.atomic.fn).stdlib/std/includingstdlib/std/c/. Verified against the real generator's own output, not an approximation: zero gaps left.v{funVersion}release tag the generated content was built from.Test plan
fun -fmt-check-allcleanfun build(full project) cleanmath.fn'ssin_dec,shapes.fn'sSized,error.fn'sErrorKind,std.c.atomic.fn's module doc) directly in the regenerated JSON to confirm no more bleednpx tsc --noEmitandnpm run build:webboth clean.fnfiles (no logic touched) - no test-suite run needed per this repo's own convention for comment-only diffs