User guide and usage related updates #454
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
New maintainer preference is to not use `:refer :all` in code and docs. This is subjective, so apologies to those who prefer `:refer :all`. This change should not affect behaviour of Etaoin. I tried to be consistent in aliasing. For example `etaoin.api :as e`. Also did a clojure-lsp clean-ns on each `ns`. Deleted extra whitespace (newlines) when I noticed. While sweeping the user guide: - attempted to understand everything I read, and elaborated where I, as a relative newcomer to Etaoin, was confused - attempted a re-org to group related sections together - reworded some sentences here and there - add a section on creating the driver - updated outdated text where I noticed it - attempted to make most example code blocks something the user could theoretically paste and run (and verified such myself) - tweaked clj-kondo hooks for with-key-down and with-pointer-btn-down, I discovered I hadn't quite got them correct enough. At same time moved to registering lint findings instead of throwing. - added in automated testing of many user guide code blocks via test-doc-blocks via `bb test-doc`, added to CI
borkdude
approved these changes
Jun 11, 2022
Chrome will fail if run as a root user on ubuntu. We could compensate by running with '--no-sandbox', but I'd rather not have generally unnecessary option in our user guide. Try switch run test-doc-block tests for the user guide to macos and see where that gets us.
Caught and corrected some, I'm sure there are more to catch.
Not sure of the cause So I add a pause
lread
added a commit
to kidd/etaoin
that referenced
this pull request
Jun 15, 2022
* master: (94 commits) Switch with-exception from private to no-doc (clj-commons#457) API review: docstrings, arglists, publics (clj-commons#456) User guide and usage related updates (clj-commons#454) docs: changelog [skip ci] docs: README: update contributors [skip ci] Add note about new tabs/windows to Troubleshooting (clj-commons#452) [skip ci] Review and update Dockerfile (clj-commons#451) lint: tweak .gitignore [skip ci] lint: abandon idea of linting clj-kondo hooks lint: lint clj-kondo hooks code too lint: update dev guide lint: distinguish internal hooks from imports lint: bump clj-kondo lint: Use bb's (clojure) instead of shelling out Add clj-kondo export config Update: cheshire 5.11.0 was just released Bump dependencies to current releases docs: update changelog [skip ci] docs: add Dave Yarwood to contributors [skip ci] Move `effectively-displayed?` docstring to the public `displayed-el?` function ...
lread
added a commit
to verma/etaoin
that referenced
this pull request
Jun 16, 2022
Ya I see it: - running? and wait-running very likely don't mean much for for a remote hosted WebDriver service as they only check the host and port for reachability. We could extract host and port from a the webdriver-url but checking that we can open a socket on port 443 for chrome.browserless.io doesn't say much about WebDriver service running at https://chrome.browserless.io/webdriver. Minor changes: - documented in user guide - added a test - minor strategy change around wait-running - check :webdriver-url for nil rather than via str/blank? (for consistency with other options) * master: (97 commits) docs: changelog [skip ci] Add new examples in getting started (clj-commons#364) Switch with-exception from private to no-doc (clj-commons#457) API review: docstrings, arglists, publics (clj-commons#456) User guide and usage related updates (clj-commons#454) docs: changelog [skip ci] docs: README: update contributors [skip ci] Add note about new tabs/windows to Troubleshooting (clj-commons#452) [skip ci] Review and update Dockerfile (clj-commons#451) lint: tweak .gitignore [skip ci] lint: abandon idea of linting clj-kondo hooks lint: lint clj-kondo hooks code too lint: update dev guide lint: distinguish internal hooks from imports lint: bump clj-kondo lint: Use bb's (clojure) instead of shelling out Add clj-kondo export config Update: cheshire 5.11.0 was just released Bump dependencies to current releases docs: update changelog [skip ci] ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New maintainer preference is to not use
:refer :allin code and docs.This is subjective, so apologies to those who prefer
:refer :all.This change should not affect behaviour of Etaoin.
I tried to be consistent in aliasing. For example
etaoin.api :as e.Also did a clojure-lsp clean-ns on each
ns.Deleted extra whitespace (newlines) when I noticed.
While sweeping the user guide:
as a relative newcomer to Etaoin, was confused
theoretically paste and run (and verified such myself)
I discovered I hadn't quite got them correct enough.
At same time moved to registering lint findings instead of throwing.
test-doc-blocks via
bb test-doc, added to CI