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.

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

[docs] public API docs IDE-compatible #231

Open
ngarbezza opened this issue Jul 13, 2022 · 0 comments
Open

[docs] public API docs IDE-compatible #231

ngarbezza opened this issue Jul 13, 2022 · 0 comments
Assignees
@ngarbezza
Labels
docs

Comments

@ngarbezza
Copy link
Owner

What is not documented or is not clear

Public methods like suite, test, before, assertions and so on are not documented.

Ideas

Follow a convention like jsdoc to write the comments and get them displayed in the IDE
@ngarbezza ngarbezza added the docs label Jul 13, 2022
@ngarbezza ngarbezza self-assigned this Jul 13, 2022
This was referenced Oct 24, 2022
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ngarbezza ngarbezza

Labels
docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ngarbezza