Skip to content

feat: add docs to the generated API #101

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
Merged
merged 8 commits into from
Jul 28, 2020
Merged

feat: add docs to the generated API #101

merged 8 commits into from
Jul 28, 2020

Conversation

mxschmitt
Copy link
Member

No description provided.

@coveralls
Copy link

coveralls commented Jul 28, 2020 •
edited
Loading

Pull Request Test Coverage Report for Build 186229103

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 263 unchanged lines in 7 files lost coverage.
  • Overall coverage increased (+0.4%) to 87.815%
Files with Coverage Reduction New Missed Lines %
playwright/_repo_version.py 1 0%
playwright/async_base.py 2 95.45%
playwright/input.py 2 93.33%
playwright/sync_base.py 2 97.22%
playwright/connection.py 4 97.81%
playwright/async_api.py 51 90.88%
playwright/sync_api.py 201 66.26%
Totals Coverage Status
Change from base Build 184715839: 0.4%
Covered Lines: 2861
Relevant Lines: 3258
💛 - Coveralls

pavelfeldman
pavelfeldman reviewed Jul 28, 2020
View reviewed changes
scripts/documentation_provider.py

def load(self) -> None:
api_md = requests.get(
"https://raw.githubusercontent.com/microsoft/playwright/master/docs/api.md"
Copy link
Member

Choose a reason for hiding this comment

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

This should be taken from the corresponding git hash upon each roll.

@mxschmitt mxschmitt mentioned this pull request Jul 28, 2020
Merged
aslushnikov pushed a commit to microsoft/playwright that referenced this pull request Jul 28, 2020
@mxschmitt
devops: include protocol and api.md in NPM package (#3195)
d27f97e 
The reason for this change is that in Playwright Python we would need the related `protocol.yml` and `api.md` for the installed NPM package. For that we could either add the Git hash to the released package e.g. as a file (and go over the GitHub repo to get the file content) but Pavel proposed that it might be better to include the two files in the NPM package.

Tested locally by adding to the `utils/publish_all_packages.sh` script `--dry` to the NPM publish commands.

cc @aslushnikov @pavelfeldman 

Related issues: microsoft/playwright-python#101 and microsoft/playwright-python#96
@pavelfeldman pavelfeldman merged commit edc6a6f into microsoft:master Jul 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pavelfeldman pavelfeldman pavelfeldman approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mxschmitt @coveralls @pavelfeldman