Remove the **MAGIC**

Open
#35 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
testing

Research direction

No files, tests, or entry points are named. Start by locating the library's polling and timeout paths, then determine how repeated polling and timeouts are currently reported. Done means the agreed polling and timeout events are logged at info level, with the remaining scope clarified.

Written by the indexing model from the issue text.

Description

Due to the goal of this library that mirrors Protractor which in turn justifiable claims that "[y]ou no longer need to add waits and sleeps to your test" and "you don’t have to worry about waiting for your test and webpage to sync." everything it accomplishes in this regard feels like MAGIC. This complicates the situation when things don't go as expected. It also downplays the importance of the end users understanding what is going on, what this library can and cannot accomplish.

This ticket lists some of the items I want to change to help remove the magic.

  1. If the library has to poll (more than once, twice, N times) than an info log statement is recorded.
  2. If the library timeouts log that piece of information at info level.
  3. [.. something else that I really can't remember at this time ..]
Dominant language
Python
Stars
33
Forks
20
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MarketSquare/robotframework-angularjs

All issues in MarketSquare/robotframework-angularjs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.