Skip to content
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.

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

docs(expect): minor doc tweaks #5501

Merged
merged 2 commits into from
Jul 22, 2024
Merged

docs(expect): minor doc tweaks #5501

merged 2 commits into from
Jul 22, 2024

Conversation

iuioiua
Copy link
Contributor

@iuioiua iuioiua commented Jul 21, 2024

No description provided.

@iuioiua iuioiua requested a review from kt3k as a code owner July 21, 2024 23:32
@iuioiua iuioiua enabled auto-merge (squash) July 21, 2024 23:32
Copy link

codecov bot commented Jul 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.30%. Comparing base (ab8f6a5) to head (d53cbe5).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5501   +/-   ##
=======================================
  Coverage   96.30%   96.30%           
=======================================
  Files         463      463           
  Lines       37669    37669           
  Branches     5561     5561           
=======================================
  Hits        36276    36276           
  Misses       1351     1351           
  Partials       42       42           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -19,14 +17,16 @@
* expect(mockFn).toHaveBeenCalledTimes(1);
* });
* ```
*
* @module
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixes module docs not being displayed.

Copy link
Member

Choose a reason for hiding this comment

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

Good catch

* const x = 6 * 7;
* expect(x).toEqual(42);
* expect(x).not.toEqual(0);
*
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Aligns with other packages which usually have an example first.

Copy link
Member

@kt3k kt3k left a comment

Choose a reason for hiding this comment

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

LGTM

@iuioiua iuioiua merged commit 88019ee into main Jul 22, 2024
16 checks passed
@iuioiua iuioiua deleted the expect-doc-tweaks branch July 22, 2024 03:17
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