Skip to content
This repository has been archived by the owner on Jan 30, 2025. It is now read-only.

Update k6-browser package documentation #1113

Merged
merged 7 commits into from
Nov 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions chromium/browser.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// Package chromium is responsible for launching a Chrome browser process and managing its lifetime.
package chromium

import (
Expand Down
4 changes: 2 additions & 2 deletions common/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
// Package common contains the implementation of API elements that do not
// depend on the browser type.
// Package common provides the main logic of the browser module.
// This package will be split into multiple packages in the future.
package common
4 changes: 4 additions & 0 deletions common/js/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// Package js provides JavaScript code that the browser module evaluates on the browser.
// The common package uses this package.
// `injected_script.js` is injected into each execution context.
package js
1 change: 1 addition & 0 deletions keyboardlayout/layout.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// Package keyboardlayout provides keyboard key interpretation and layout validation.
package keyboardlayout

import (
Expand Down
1 change: 1 addition & 0 deletions log/logger.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// Package log provides logging for the browser module.
package log

import (
Expand Down
1 change: 1 addition & 0 deletions storage/storage.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// Package storage provides data storage for the extension and user specific data.
package storage

import (
Expand Down
3 changes: 2 additions & 1 deletion tests/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
// Package tests contains integration tests.
// Package tests provides integration tests.
// The `testBrowser` type enables us to test the browser module with a real browser.
package tests
Loading