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: indicate 'exports' interface does not work in browsers #5181

Merged
merged 6 commits into from
Oct 30, 2024

Conversation

deyjoy
Copy link
Contributor

@deyjoy deyjoy commented Jul 23, 2024

Update Documentation for "Exports" Interface Browser Incompatibility

Description

This pull request updates the Mocha documentation to indicate that the "exports" interface does not work in browser environments. The following changes have been made:

  • docs/index.md: Added a note under the relevant section explaining the limitation with the "exports" interface.
  • docs/API.md: Added a note under the "exports" interface section explaining its incompatibility with browsers.

References

Testing

  • Verified the documentation builds correctly.
  • Checked links and references for accuracy.

Please review and let me know if any further changes are needed.

Thank you!

Copy link

linux-foundation-easycla bot commented Jul 23, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

Copy link
Member

@voxpelli voxpelli left a comment

Choose a reason for hiding this comment

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

Can we add the documentation within the exports section of the documentation? https://mochajs.org/#exports

@deyjoy
Copy link
Contributor Author

deyjoy commented Aug 6, 2024

Thank you @voxpelli for the feedback! I will make the requested changes and update the documentation within the exports section as soon as possible.

@deyjoy deyjoy force-pushed the update-browser-docs branch from bcdd857 to 0409d42 Compare August 18, 2024 01:25
@deyjoy deyjoy requested a review from voxpelli August 18, 2024 20:28
@deyjoy
Copy link
Contributor Author

deyjoy commented Aug 18, 2024

Hi @voxpelli,

I’ve moved the note about the exports interface’s browser incompatibility to the exports section in index.md as requested and removed it from API.md to avoid redundancy. Please take a look when you have a moment.

Thanks for the feedback!

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 one small stylistic change that I think we'll want to avoid. Thanks! 📝

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@JoshuaKGoldberg JoshuaKGoldberg added the status: waiting for author waiting on response from OP - more information needed label Oct 8, 2024
docs/index.md Outdated Show resolved Hide resolved
@JoshuaKGoldberg JoshuaKGoldberg merged commit 14e640e into mochajs:main Oct 30, 2024
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: waiting for author waiting on response from OP - more information needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

📝 Docs: Indicate that "exports" interface does not work in browsers
3 participants