Skip to content

docs: improve third-party reporter docs #5285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Jan 6, 2025
Merged

docs: improve third-party reporter docs #5285

merged 4 commits into from
Jan 6, 2025

Conversation

mark-wiemer
Copy link
Member

@mark-wiemer mark-wiemer commented Jan 3, 2025 •
edited by JoshuaKGoldberg
Loading

PR Checklist

Overview

  • Document the Runner.constants value used by reporters
  • Mention the "missing" documentation in Runnable class
    • Runnable.prototype.xyz calls are not published to the API doc site, leading to confusion about which properties are included in a Runnable object, like a Test or a Hook.

@mark-wiemer mark-wiemer changed the title Mark wiemer/3104 third party reporters docs Fix: Improve third-party reporter docs Jan 3, 2025
@mark-wiemer mark-wiemer changed the title Fix: Improve third-party reporter docs fix: Improve third-party reporter docs Jan 3, 2025
@mark-wiemer
Copy link
Member Author

@JoshuaKGoldberg this is ready for review, please let me know what I'm doing wrong with these darn compliance checks, I've read the verbose logs and I'm still confused!

JoshuaKGoldberg
JoshuaKGoldberg reviewed Jan 3, 2025
View reviewed changes
@JoshuaKGoldberg
Copy link
Member

From https://github.com/mochajs/mocha/actions/runs/12599907071/job/35117787163?pr=5285:

Warning: PR Body did not match required format

Heh. Not exactly informative. I think this would be fixed by mtfoley/pr-compliance-action#368 -> mtfoley/pr-compliance-action#374.

Anyway, it's that this doesn't "fix" an existing issue - just "works on". I edited the body now that the other PR is resolved. ✅

JoshuaKGoldberg
JoshuaKGoldberg requested changes Jan 3, 2025
View reviewed changes
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Just a couple of question/touchup points?

@JoshuaKGoldberg JoshuaKGoldberg added the status: waiting for author waiting on response from OP or other posters - more information needed label Jan 3, 2025
mark-wiemer and others added 2 commits January 3, 2025 16:31
@mark-wiemer @JoshuaKGoldberg
Update lib/runnable.js
76a15de 
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
@mark-wiemer
Update lib/runnable.js
840dec8
@JoshuaKGoldberg JoshuaKGoldberg changed the title fix: Improve third-party reporter docs docs: improve third-party reporter docs Jan 6, 2025
JoshuaKGoldberg
JoshuaKGoldberg approved these changes Jan 6, 2025
View reviewed changes
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lovely, thanks :)

@JoshuaKGoldberg JoshuaKGoldberg merged commit c5a0ef5 into mochajs:main Jan 6, 2025
76 checks passed
@github-actions github-actions bot mentioned this pull request Jan 6, 2025
Merged
@mark-wiemer mark-wiemer deleted the mark-wiemer/3104-third-party-reporters-docs branch July 12, 2025 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JoshuaKGoldberg JoshuaKGoldberg JoshuaKGoldberg approved these changes

Assignees
No one assigned
Labels
status: waiting for author waiting on response from OP or other posters - more information needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

📝 Docs: No documentation on third party reporters example
2 participants
@mark-wiemer @JoshuaKGoldberg