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(consoleMessage): add missing console message comments #6320

Merged
merged 5 commits into from
May 5, 2021

Conversation

kblok
Copy link
Contributor

@kblok kblok commented Apr 26, 2021

@kblok kblok changed the title docs(consoleMessage): document console message text docs(consoleMessage): add missing console message comments Apr 26, 2021
@kblok kblok force-pushed the vGeneratred/document-console-text branch from c52f004 to 778716e Compare April 26, 2021 12:50
docs/src/api/class-consolemessage.md Outdated Show resolved Hide resolved
@kblok kblok force-pushed the vGeneratred/document-console-text branch from 778716e to 7ea4e4f Compare April 26, 2021 21:41
docs/src/api/class-consolemessage.md Outdated Show resolved Hide resolved
kblok and others added 2 commits April 26, 2021 18:52
Co-authored-by: Max Schmitt <max@schmitt.mx>
@@ -5,6 +5,25 @@
## method: ConsoleMessage.args
- returns: <[Array]<[JSHandle]>>

List or arguments passed to a `console` function call.

```js
Copy link
Member

Choose a reason for hiding this comment

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

This js snippet feels very lonely without its Python, Java and C# friends.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I found that I was about to replicate the docs from Page.console. Added a link to that. @yury-s might want to confirm a fix in the java docs.

I found this dotnet tool a few months ago https://github.com/SimonCropp/MarkdownSnippets. Although it's .NET only, the idea is straightforward. You code the code example on a compilable place such as a unit test. And the doc would point to that snippet. Then you have a process that would replace the snippet with that code.
Just for you to think about it.

@kblok kblok force-pushed the vGeneratred/document-console-text branch from efa8e48 to 00ffd9e Compare April 30, 2021 12:41
@kblok kblok requested a review from pavelfeldman May 4, 2021 18:39
@yury-s yury-s merged commit 9e36f5c into microsoft:master May 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing doc on IConsoleMessage.Text
4 participants