Skip to content

docs(IRequest): streamline duplicate docs + update for clarity and accuracy#60889

Open
joshtrichards wants to merge 15 commits into
masterfrom
jtr/cleanup-Request
Open

docs(IRequest): streamline duplicate docs + update for clarity and accuracy#60889
joshtrichards wants to merge 15 commits into
masterfrom
jtr/cleanup-Request

Conversation

@joshtrichards
Copy link
Copy Markdown
Member

@joshtrichards joshtrichards commented May 31, 2026

  • Resolves: #

Summary

The implementation duplicated a lot of function-level docblocks that were already in the interface. A few were also only in the implementation. In addition, some was inaccurate, extraneous, or unclear.

Changes:

  • Drop duplicate method-level docblocks from implementation class that are already specified in the public interface
  • Fix inaccuracies in and clarify interface docblocks
  • Unify property-read usage across interface and implementation
  • Refactor (simple) of getHeader() for some slight additional clarity
  • Adds missing psalm typing where it was previously missing / isn't already declared inline

TODO

  • ...

Checklist

AI (if applicable)

  • The content of this PR was partly or fully generated using AI

Signed-off-by: Josh <josh.t.richards@gmail.com>
Oh and slighly refactor getHeader() since this was tied to some other work that lead to this cleanup.

Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
…arameter set methods

Signed-off-by: Josh <josh.t.richards@gmail.com>
…riever methods

Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
…arity

Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
@joshtrichards joshtrichards added 3. to review Waiting for reviews technical debt 🧱 🤔🚀 labels May 31, 2026
@joshtrichards joshtrichards marked this pull request as ready for review May 31, 2026 17:14
@joshtrichards joshtrichards requested a review from a team as a code owner May 31, 2026 17:14
@joshtrichards joshtrichards requested review from Altahrim and leftybournes and removed request for a team May 31, 2026 17:14
@joshtrichards joshtrichards changed the title docs(IRequest): streamline duplicate material + update for clarity and accuracy docs(IRequest): streamline duplicate docs + update for clarity and accuracy May 31, 2026
@joshtrichards
Copy link
Copy Markdown
Member Author

@copilot resolve the merge conflicts in this pull request

Signed-off-by: Carl Schwan <carl@carlschwan.eu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants