Skip to content

chore: Improve utility documentation#2254

Open
marcustyphoon wants to merge 13 commits into
masterfrom
marcustyphoon/document-utils
Open

chore: Improve utility documentation#2254
marcustyphoon wants to merge 13 commits into
masterfrom
marcustyphoon/document-utils

Conversation

@marcustyphoon

@marcustyphoon marcustyphoon commented May 18, 2026

Copy link
Copy Markdown
Collaborator

Description

Adds additional documentation to many utility module exports.

Please feel free to commit improvements directly to this branch if appropriate, cherry pick these, etc, April.

Testing steps

n/a

@marcustyphoon marcustyphoon added the help wanted Extra attention is needed label May 18, 2026
@marcustyphoon

marcustyphoon commented May 27, 2026

Copy link
Copy Markdown
Collaborator Author

@AprilSylph what I ran into when working on this, and helpwanted this for, is potentially related to #2263/#2264: what, precisely, is the isMyPost utility supposed to represent? I recall us putting some thought into it, but couldn't find the discussion. My best read on it is that it identifies posts the user to have had a direct hand in authoring, I guess? We should clearly document this (and should double check whether it's the right behavior where it's used).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

help wanted Extra attention is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant