Skip to content

Commit

Permalink
docs: mark ChromiumBrowserContext as js and python specific (#5255)
Browse files Browse the repository at this point in the history
  • Loading branch information
@yury-s
yury-s committed Feb 2, 2021
1 parent 8c65871 commit 5564b20
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/src/api/class-chromiumbrowsercontext.md
View file
@@ -1,4 +1,5 @@
# class: ChromiumBrowserContext
* langs: js, python
* extends: [BrowserContext]

Chromium-specific features including background pages, service worker support, etc.
Expand Down

2 comments on commit 5564b20

@avodovnik
Copy link
Contributor

Choose a reason for hiding this comment

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

@yury-s this causes a problem when generating the docs due to https://github.com/microsoft/playwright/blob/master/docs/src/api/class-browsercontext.md#method-browsercontextpages.

Is there a reason this is specific to these languages? I can go ahead and remove the reference from the BrowserContext class, or we can come up with a better alternative? :)

@yury-s
Copy link
Member Author

@yury-s yury-s commented on 5564b20 Feb 5, 2021

Choose a reason for hiding this comment

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

Is there a reason this is specific to these languages?

We don't want to expose browser-specific stuff in Java at least for now and I was following the same strategy for C#.

I can go ahead and remove the reference from the BrowserContext class, or we can come up with a better alternative? :)

We could have to flavors of the method documentation, one that mentions background page and the other which does not.

Please sign in to comment.