v3: comments say what the code can't — the documentation pass wanted JSDoc on every export and every field of an exported interface, which filled the code with restatements ("The dump.", "Whether it is loading.", "The props of X.", "Renders the X.") and module docs that told a reader nothing ("The hot and new feeds, and the props every main feed of the index takes."); some were wrong as well as vague. Every comment in api/, shared/ and src/ is rewritten under one rule, now stated in the README's "Comments" section: every module and export still has a JSDoc, and it gives context (who uses it and where), usage (what a caller must know: a precondition, what it leaves to the caller, a side effect) or its place in the chain (where its input comes from, where its output goes); a field, parameter, private function or local gets one only when it adds to its parent's, and context about a whole type goes on the type; a type's doc is phrased from the value's side ("Returned to Y by X when Z", "Passed to Y by X"); full sentences, as short as they can be, no label-colon-list; // goes wherever the code isn't obvious and says why, and the section banners and narration go. Every claim was checked against the code, which turned up some forty comments that were wrong: DumpCard's claimed it was only used by the hot and new feeds, the WebSocket welcome claimed to be a socket's first message (presence comes first), UpdateUserRequest said null removes a description (it keeps it), deletedDumpIds leaves out that it also holds dumps made private, THEME_COLOR claimed to mirror index.html's, and the like. The routers' JSDoc now says where they are mounted and what becomes of a thrown APIException. doc-lint.ts lets a field without a doc through; a module or export without one still fails. No code changes; 204 backend and 628 frontend tests pass, and doc:lint, deno check, deno lint and tsc are clean.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Binary file not shown.
@@ -1,5 +1,5 @@
|
||||
/**
|
||||
* A dump form's category picker.
|
||||
* Renders the category picker of the dump creation dialog and the dump editor.
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
@@ -7,20 +7,19 @@
|
||||
import { Trans } from "@lingui/react/macro";
|
||||
import { useCategories } from "../../hooks/category/useCategories.ts";
|
||||
|
||||
/** The props of {@link CategorySelect}. */
|
||||
/**
|
||||
* Passed to {@link CategorySelect} by `DumpCreateModal` and `DumpEdit`, which
|
||||
* hold the selection and send it as the dump's `categoryIds`.
|
||||
*/
|
||||
export interface CategorySelectProps {
|
||||
/** The ids of the categories chosen. */
|
||||
selected: Set<string>;
|
||||
/** Called with the id of a category toggled. */
|
||||
onToggle: (id: string) => void;
|
||||
/** Whether the chips are disabled. */
|
||||
disabled?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Renders a multi-select of categories as toggle chips. Renders nothing when
|
||||
* no categories are configured, so dump forms stay unchanged until an admin
|
||||
* adds the first category.
|
||||
* Renders the categories as toggle chips, any number of which may be on. It
|
||||
* renders nothing while the site has no categories.
|
||||
*/
|
||||
export function CategorySelect(
|
||||
{ selected, onToggle, disabled }: CategorySelectProps,
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
/**
|
||||
* The feed's category switcher.
|
||||
* Renders the menu that switches the index page's feed between all dumps and a
|
||||
* category.
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
@@ -18,14 +19,9 @@ import { useCategories } from "../../hooks/category/useCategories.ts";
|
||||
import { DEFAULT_FEED_TAB } from "../../config/feedTabs.ts";
|
||||
|
||||
/**
|
||||
* Renders the header dropdown that switches the feed scope between "All" and a
|
||||
* category, preserving the active feed tab (e.g. /music/new → /cinema/new).
|
||||
* Rendered as the leading item of the feed-sort tab row so it reads as part of
|
||||
* the bar.
|
||||
*
|
||||
* A custom popover (not a native <select>) keeps it on-theme; the menu uses
|
||||
* fixed positioning so the row's `overflow-x: auto` can't clip it. `~` is the
|
||||
* sentinel value for the all-categories feed. Hidden when no categories exist.
|
||||
* Renders the category menu at the head of `FeedTabBar`. Picking a category
|
||||
* keeps the feed tab, from `/music/new` to `/cinema/new`, and "All" leads to
|
||||
* `/~/new`. It renders nothing while the site has no categories.
|
||||
*/
|
||||
export function CategorySwitcher(): React.JSX.Element | null {
|
||||
const { categories } = useCategories();
|
||||
@@ -38,8 +34,8 @@ export function CategorySwitcher(): React.JSX.Element | null {
|
||||
const btnRef = useRef<HTMLButtonElement>(null);
|
||||
const menuRef = useRef<HTMLUListElement>(null);
|
||||
|
||||
// Close on outside click / Escape. The menu is portaled out of the wrapper,
|
||||
// so check it separately or selecting an option would close before navigating.
|
||||
// The menu is portaled out of the wrapper, so a click in it would count as
|
||||
// outside and close it before the option's click could navigate.
|
||||
useEffect(() => {
|
||||
if (!open) return;
|
||||
function onDown(e: MouseEvent) {
|
||||
@@ -62,7 +58,8 @@ export function CategorySwitcher(): React.JSX.Element | null {
|
||||
};
|
||||
}, [open]);
|
||||
|
||||
// Anchor the fixed-position menu to the trigger; keep it aligned on scroll.
|
||||
// The menu is fixed and portaled to <body>, so the tab row's
|
||||
// `overflow-x: auto` can't clip it. It must follow the button on scroll.
|
||||
useLayoutEffect(() => {
|
||||
if (!open) return;
|
||||
const update = () => {
|
||||
|
||||
Reference in New Issue
Block a user