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.

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

update wait documentation #1358

Merged
merged 3 commits into from Aug 4, 2023
Merged

update wait documentation #1358

merged 3 commits into from Aug 4, 2023

Conversation

titusfortner
Copy link
Member

Description

  • Removed the static code examples and replaced with references code in the examples directory
  • Added a section on hard coded sleeps; not technically a Selenium "feature," so maybe we don't want this?
  • Removed Java-specific comments
  • Removed the "Fluent Wait" section because that term only applies to Java (the example for customizing the explicit wait for Java uses the FluentWait class)
  • Moved Expected Conditions out of the Wait page and into the Support Features page
  • All explicit wait examples use lambdas not conditions classes
  • Hopefully the explanations are more clear and focuses on the important bits

Motivation and Context

  • Code examples were not working
  • Descriptions were repetitive and overly technical

@netlify
Copy link

netlify bot commented Apr 13, 2023 •
edited

✅ Deploy Preview for selenium-dev ready!

Name Link
🔨 Latest commit d671027
🔍 Latest deploy log https://app.netlify.com/sites/selenium-dev/deploys/64cc1f4a9f1816000867803f
😎 Deploy Preview https://deploy-preview-1358--selenium-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

harsha509
harsha509 previously approved these changes Apr 13, 2023
View reviewed changes
Copy link
Member

@harsha509 harsha509 left a comment

Choose a reason for hiding this comment

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

LGTM!

iamalittletester
iamalittletester reviewed Apr 13, 2023
View reviewed changes
website_and_docs/content/documentation/webdriver/waits.en.md Outdated Show resolved Hide resolved
website_and_docs/content/documentation/webdriver/waits.en.md Outdated Show resolved Hide resolved
website_and_docs/content/documentation/webdriver/waits.en.md Outdated Show resolved Hide resolved
website_and_docs/content/documentation/webdriver/waits.en.md Outdated Show resolved Hide resolved
website_and_docs/content/documentation/webdriver/waits.en.md Outdated Show resolved Hide resolved
website_and_docs/content/documentation/webdriver/waits.en.md Outdated Show resolved Hide resolved
website_and_docs/content/documentation/webdriver/waits.en.md Outdated Show resolved Hide resolved
website_and_docs/content/documentation/webdriver/waits.en.md Outdated Show resolved Hide resolved
website_and_docs/content/documentation/webdriver/waits.en.md Outdated Show resolved Hide resolved
website_and_docs/content/documentation/webdriver/waits.en.md Outdated Show resolved Hide resolved
@harsha509 harsha509 dismissed their stale review April 26, 2023 15:05

review comments provided my @iamalittletester!

@maxdobeck maxdobeck mentioned this pull request May 30, 2023
Closed
@ollie-iterators
Copy link

If there are more areas that need their static code to be changed to references to the examples directory, I think there should be an issue added about the areas that need this to happen.

@titusfortner titusfortner mentioned this pull request Jun 15, 2023
Merged
@titusfortner
Copy link
Member Author

@ollie-iterators if we merge the PR I just linked we can tag the static code with {{ badge-examples }} to indicate that it needs to be moved over.

I'm planning to record some screen captures next week walking through each step of contributing to the documentation to better document what we're asking people to do to help.

@ollie-iterators
Copy link

@ollie-iterators if we merge the PR I just linked we can tag the static code with {{ badge-examples }} to indicate that it needs to be moved over.

I'm planning to record some screen captures next week walking through each step of contributing to the documentation to better document what we're asking people to do to help.

Great.

@titusfortner
Copy link
Member Author

Oof, this totally fell off my radar; I was going to do a quick update to get these changes out there, and of course... the structure is still confusing...

@titusfortner
Copy link
Member Author

Ok, removed a bunch of repetitive things in explicit waits section, hopefully easier to read now.

@titusfortner
Copy link
Member Author

odd there were a couple other places with double parens that seemed to work. Oh, I bet it was the combination double parens and the anchor reference at the end of the link...
Fixed all of them anyway

harsha509
harsha509 approved these changes Aug 4, 2023
View reviewed changes
Copy link
Member

@harsha509 harsha509 left a comment

Choose a reason for hiding this comment

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

Thank you @titusfortner 🎉

@harsha509 harsha509 merged commit d1af4fe into trunk Aug 4, 2023
7 checks passed
@harsha509 harsha509 deleted the waits branch August 4, 2023 04:04
selenium-ci added a commit that referenced this pull request Aug 4, 2023
@selenium-ci
update wait documentation (#1358)[deploy site]
0503dae 
* update wait documentation

* updates based on feedback and removing unnecessary explanations

* fix all double-parentheses links d1af4fe
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@harsha509 harsha509 harsha509 approved these changes

@iamalittletester iamalittletester iamalittletester approved these changes

@diemol diemol Awaiting requested review from diemol

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

Successfully merging this pull request may close these issues.

None yet
4 participants
@titusfortner @ollie-iterators @harsha509 @iamalittletester