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.
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
Update docs and make them more lean #458
Conversation
docs/faq.md
Outdated
@@ -18,9 +26,16 @@ assertions. The ability to search for elements (using search actions) makes test | |||
UI changes. For example, EarlGrey provides APIs that allow searching for elements in scrollable | |||
containers, regardless of the amount of scrolling required. | |||
|
|||
**Why do tests have the video cropped? How can I get them to fit in the video frame?** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IIRC it's not cropped. It's just scaled w/ borders around it. Plz double check?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
docs/faq.md
Outdated
**I get a crash with “Could not swizzle …”** | ||
|
||
This means that EarlGrey is trying to swizzle a method that it has swizzled before. It is a result of EarlGrey being linked to more than once. Ensure that only the **Test Target** | ||
This means that EarlGrey is trying to swizzle a method that it has swizzled before. It is a result | ||
of EarlGrey being linked to more than once. Ensure that only the **Test Target** | ||
depends on *EarlGrey.framework* and EarlGrey.framework is embedded in the app under test (i.e. *$TEST_HOST*) from the | ||
test target's build phase. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
from the test target's build phase via Copy File(s) Script?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
docs/install-and-run.md
Outdated
|
||
### CocoaPods installation | ||
|
||
For EarlGrey, we highly recommend [CocoaPods](https://cocoapods.org/) as the best way to get started. | ||
#### Step 1: Set up a Unit target ///// EarlGrey adds changes to the test target's Scheme and Build Phases |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
///// ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comment I forgot to erase. Thanks.
docs/install-and-run.md
Outdated
|
||
<img src="images/image00.png" width="500"> | ||
Click Next → "Add a Test Target Name" → Finish. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
make this bold like others? or keep em consistent. also what's special about "Add a Test Target Name". I don't think Xcode 8 has those screens.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It isn't a concrete button title but more of an action to be done. Made the step actions bold throughout.
docs/install-and-run.md
Outdated
`pod install` command. If your **Test Target(s)** do not contain these changes to the | ||
[Scheme](#scheme-changes) and [Build Phases](#build-phase-changes) after running | ||
`pod install`, please re-run `pod install` again. | ||
And clock on Close. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
clock => click...make Close bold?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
:( Done.
docs/install-and-run.md
Outdated
PROJECT_NAME = 'SampleApp' | ||
TEST_TARGET = 'SampleAppTests' | ||
SCHEME_FILE = 'SampleAppTests.xcscheme' | ||
```ruby |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
indentations seem to be removed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
docs/install-and-run.md
Outdated
To download a particular version of the gem, use `gem install earlgrey -v x.y.z`. | ||
5. Install the EarlGrey gem by doing `gem install earlgrey` and then do the `pod install`. | ||
|
||
Notes: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to highlight this like notes, maybe light blue or green section?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It doesn't seem like it's possible to add color to plaintext in Github markdown.
http://stackoverflow.com/questions/11509830/how-to-add-color-to-githubs-readme-md-file
docs/install-and-run.md
Outdated
|
||
2. As part of the initial build step, a script **setup-earlgrey.sh** will be run to download all the required dependencies. Without it, you might find dependencies like `fishhook` and `OCHamcrest` shown as missing in the folder structure. | ||
2. As part of the initial build step, a script **setup-earlgrey.sh** will be run to download all the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
link to setup-earlgrey.sh
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
docs/install-and-run.md
Outdated
#### Step 1: Set up a test target for Carthage | ||
|
||
See [Step 1 from the `CocoaPods installation`](#step-1-set-up-a-test-target) detailed above. | ||
|
||
#### Step 2: Configure carthage | ||
|
||
Install Carthage | ||
1. Install Carthage | ||
|
||
`brew update; brew install carthage` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
instead of ` so that it looks like the code blocks above. The color of code block using ` seems slightly different from
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd have to surround all in a ``` to get them to look the same. These are steps to be performed rather than code blocks, so I'd assume that should be fine. Do you think it would be better to turn these into code blocks?
docs/install-and-run.md
Outdated
|
||
The EarlGrey tests are hosted from the application being tested. Make sure the test target is setup | ||
correctly to launch the app under test: | ||
|
||
1. Under the **General** tab: | ||
* **Host Application** is set to the app under test. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this shows up as:
Under the General tab: a) Host Application is set to the app under test.
Please fix it here and for the other numbered bullets below
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding a) etc. doesn't seem to indent this correctly. Just changed this to * everywhere.
71e5def
to
c6876c1
Compare
docs/faq.md
Outdated
@@ -1,5 +1,13 @@ | |||
# FAQ | |||
|
|||
**I did a fresh `git clone` of the EarlGreyExample CocoaPods Demo project followed by a | |||
`pod install`. However, I get an error similar to `No such module 'EarlGrey'`.** | |||
This is a known issue with EarlGrey's CocoaPods support. EarlGrey requires some additions to the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you need an empty line after the bold text
**question**
answer
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
docs/faq.md
Outdated
test project's Build Settings and Schemes. If your **Test Target(s)** do not contain these changes | ||
to the [Scheme](./install-and-run.md#scheme-changes) and | ||
[Build Phases](./install-and-run.md#build-phase-changes) after running `pod install`, please re-run | ||
`pod install` again.' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
again.'
should have the '
removed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
docs/faq.md
Outdated
@@ -29,7 +46,7 @@ undefined.” in the logs** | |||
|
|||
This usually means that EarlGrey is being linked to more than once. Ensure that only the **Test Target** | |||
depends on *EarlGrey.framework* and EarlGrey.framework is embedded in the app under test (i.e. *$TEST_HOST*) from the | |||
test target's build phase. | |||
test target's built products via a Copy File(s) script. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed to Copy Files(s) Build Phase
docs/install-and-run.md
Outdated
You can add EarlGrey to Xcode projects in two ways: using CocoaPods, or as a framework. If you wish to contribute to the EarlGrey project, the **EarlGrey.xcodeproj** generated from the [GitHub Installation](#github-installation) section is integrated with the Unit and Functional Test projects for you to work with the source. | ||
You can add EarlGrey to Xcode projects in three ways: using CocoaPods, Carthage or manually through the Xcode Project. | ||
|
||
For EarlGrey, we highly recommend [CocoaPods](http://cocoapods.org/pods/EarLGrey) as the best way to get started. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use https. Also the L should not be capitalized.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
docs/install-and-run.md
Outdated
To download a particular version of the gem, use `gem install earlgrey -v x.y.z`. | ||
Notes: | ||
* Call the `configure_for_earlgrey` method for each target / Scheme. | ||
* For compatibility between different versions, please peruse [this doc](https://github.com/google/EarlGrey/tree/master/docs/versions.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please see [this doc]
seems more natural.
I think we should start matching the gem versions with EG versions. Asking users to consult a compatability document isn't a great user experience.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We tried discussing this before. Won't going from 0.1.6 to 1.8 or so be odd?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think so. Using 0.1.6 for EarlGrey 1.8 is a bit confusing. The gem is stable now, is there a reason to stay on 0.x.x?
Gem 1.8 for EarlGrey 1.8 seems like a natural fit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds fine. We're going to have to get them to parity sometime soon, though it would probably break semantic versioning for the gem. @khandpur WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think moving to 1.x.x is in line with semver.
How do I know when to release 1.0.0?
If your software is being used in production, it should probably already be 1.0.0. If you have a stable API on which users have come to depend, you should be 1.0.0. If you’re worrying a lot about backwards compatibility, you should probably already be 1.0.0.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But to keep them in parity we're going to have to move them to 1.8.1 for the next release right? Will that be fine?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it will be fine. In general there's no deep meaning to the Ruby gem version numbers. In this specific case, I think version parity is more important than strictly following semver.
docs/install-and-run.md
Outdated
1. Download the source for EarlGrey and its dependencies. | ||
* Download EarlGrey's source code from the [Latest Release](https://github.com/google/EarlGrey/archive/1.0.0.zip) | ||
1. Download the source for EarlGrey and its dependencies. | ||
* Download EarlGrey's source code from the [Latest Release](https://github.com/google/EarlGrey/archive/1.0.0.zip) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1.0 is not the latest release. Use this link instead:
https://github.com/google/EarlGrey/releases/latest
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. Thanks!
docs/install-and-run.md
Outdated
|
||
* Unzip and go to the `EarlGrey-1.0.0/EarlGrey` directory that contains **EarlGrey.xcodeproj**. | ||
* Unzip and go to the `EarlGrey-1.0.0/EarlGrey` directory that contains **EarlGrey.xcodeproj**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should probably make this version independent:
EarlGrey-x.y.z/EarlGrey
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
docs/install-and-run.md
Outdated
``` | ||
|
||
> For compatibility with Swift, we use `grey_allOfMatchers()` and `grey_anyOfMatchers()` instead of `grey_allOf()` | ||
and `grey_anyOf()` respectively. | ||
> For compatibility with Swift 2.3, we use `grey_allOfMatchers()` and `grey_anyOfMatchers()` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this no longer an issue on Swift 3? otherwise I don't think it makes sense to say 2.3.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We still use grey_allOfMatchers
in Swift 3. Removed the 2.3 sicne it was a little confusing.
docs/faq.md
Outdated
launch screen images present for all supported devices (see | ||
[iOS Developer Library, Launch Files](https://developer.apple.com/library/ios/documentation/UserExperience/Conceptual/MobileHIG/LaunchImages.html)). | ||
|
||
**Why does EarlGrey need to modify the test's scheme and add a Copy Files Build Phase?** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@khandpur PTAL. Added a question to address info for the scheme changes.
docs/install-and-run.md
Outdated
|
||
### Carthage Installation | ||
|
||
EarlGrey supports Carthage via [the EarlGrey gem.](https://rubygems.org/gems/earlgrey) | ||
|
||
#### Step 1: Set up a test target for Carthage | ||
|
||
See [Step 1 from the `CocoaPods installation`](#step-1-set-up-a-test-target) detailed above. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can this just be written out? Section 3 documents running pod install
which shouldn't apply here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AVandelay sorry, I'm a little confused here.
#### Step 1: Set up a Unit target
doesn't mention pod install
. Am I looking at something else?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sorry. I was comparing with the version currently published. Looks like this comment is irrelevant now.
docs/install-and-run.md
Outdated
## Install EarlGrey | ||
|
||
You can add EarlGrey to Xcode projects in two ways: using CocoaPods, or as a framework. If you wish to contribute to the EarlGrey project, the **EarlGrey.xcodeproj** generated from the [GitHub Installation](#github-installation) section is integrated with the Unit and Functional Test projects for you to work with the source. | ||
You can add EarlGrey to Xcode projects in three ways: using CocoaPods, Carthage or manually through the Xcode Project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
using CocoaPods, Carthage or manually
Can we add links for each so clicking on Cocoapods takes me directly to cocoapods installation instructions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
docs/install-and-run.md
Outdated
|
||
### CocoaPods installation | ||
|
||
For EarlGrey, we highly recommend [CocoaPods](https://cocoapods.org/) as the best way to get started. | ||
#### Step 1: Set up a Unit target |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unit => Unit test
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
docs/install-and-run.md
Outdated
configure_for_earlgrey(installer, PROJECT_NAME, TEST_TARGET, SCHEME_FILE) # EarlGrey Gem Call | ||
end | ||
``` | ||
4. Install the EarlGrey gem by doing `gem install earlgrey` and then do the `pod install`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Move gem install out to first step.
Then in the step where user is asked to do configure_for_earlgrey, tell them they do it for each target / Scheme.
The very last step should be pod install along with this note:
For compatibility between different versions, please see this doc. To download a particular version of the gem, use gem install earlgrey -v x.y.z.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
docs/install-and-run.md
Outdated
Notes: | ||
* Call the `configure_for_earlgrey` method for each target / Scheme. | ||
* For compatibility between different versions, please see [this doc](https://github.com/google/EarlGrey/tree/master/docs/versions.md). | ||
To download a particular version of the gem, use `gem install earlgrey -v x.y.z`. | ||
|
||
#### Step 3: Run the pod install command |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
docs/install-and-run.md
Outdated
1. Download the source for EarlGrey and its dependencies. | ||
* Download EarlGrey's source code from the [Latest Release](https://github.com/google/EarlGrey/archive/1.0.0.zip) | ||
1. Download the source for EarlGrey and its dependencies. | ||
* Download EarlGrey's source code from the [Latest Release](https://github.com/google/EarlGrey/releases/latest) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not intended correctly here and below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. Changed the indentation throughout.
docs/install-and-run.md
Outdated
1. Include the `EarlGrey.swift` file in your Swift Test Project. The file contains functions that | ||
implement C preprocessor macros that aren't available in Swift. | ||
#### Using the [earlgrey gem](https://rubygems.org/gems/earlgrey): | ||
* We recommend uisng the EarlGrey gem to use EarlGrey with Swift. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove this. It's inferred
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
docs/install-and-run.md
Outdated
EarlGrey.select(elementWithMatcher: grey_accessibilityID("ClickMe")) | ||
.assert(grey_sufficientlyVisible()) | ||
// Select the button with Accessibility ID "clickMe" and assert it's visible. | ||
EarlGrey.select(elementWithMatcher: grey_accessibilityID("ClickMe")) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
indentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
docs/install-and-run.md
Outdated
``` | ||
|
||
> For compatibility with Swift, we use `grey_allOfMatchers()` and `grey_anyOfMatchers()` instead of `grey_allOf()` | ||
and `grey_anyOf()` respectively. | ||
> For compatibility with Swift, we use `grey_allOfMatchers()` and `grey_anyOfMatchers()` instead |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't need this at all here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
docs/install-and-run.md
Outdated
EarlGrey currently supports Swift 3.0 and 2.3. While 3.0 is the default, you can also use 2.3 by adding | ||
`{swift: true, swift_version: 2.3}`. | ||
EarlGrey currently supports Swift 3.0 and 2.3. While 3.0 is the default, you can also use 2.3 | ||
by adding `{swift: true, swift_version: 2.3}`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
{swift: true, swift_version: 2.3} where? in Podfile?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed this altogether. Don't think it's needed and the gem docs provide any needed details.
docs/install-and-run.md
Outdated
@@ -263,40 +275,39 @@ your test and in your application code and use the built-in tools seamlessly. | |||
|
|||
### Swift |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Get rid of this section and move it closer to where are integrating w/ gem and manual installation when they're integrating with EarlGrey. Makes them optional for swift only.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. Moved the needed sections to the installation steps.
docs/faq.md
Outdated
@@ -1,5 +1,14 @@ | |||
# FAQ | |||
|
|||
**I did a fresh `git clone` of the EarlGreyExample CocoaPods Demo project followed by a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doesn't Hao's changes nullify this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It most certainly will.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Kept it here for now for Hao to update it with the latest changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
He plans on getting it in for the next release so lets remove this? we might forget to not remove it.
docs/faq.md
Outdated
launch screen images present for all supported devices (see | ||
[iOS Developer Library, Launch Files](https://developer.apple.com/library/ios/documentation/UserExperience/Conceptual/MobileHIG/LaunchImages.html)). | ||
|
||
**Why does EarlGrey need to modify the test's scheme and add a Copy Files Build Phase?** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this really one of the FAQ?
In general, we shouldn't add Q's to FAQ section unless they are actually asked frequently. For one-time questions SO is the better option.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add this to ifaq.md
for infrequently asked questions? This came up as part of the AWS eval. It'd be nice to have an official answer instead of sending people to SO or Google. Other iOS frameworks don't require this setup so I think it makes sense to explain why this is necessary.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added an ifaq.md
file with this question.
docs/faq.md
Outdated
@@ -29,7 +58,7 @@ undefined.” in the logs** | |||
|
|||
This usually means that EarlGrey is being linked to more than once. Ensure that only the **Test Target** | |||
depends on *EarlGrey.framework* and EarlGrey.framework is embedded in the app under test (i.e. *$TEST_HOST*) from the | |||
test target's build phase. | |||
test target's built products via a Copy File(s) Build Phase. | |||
|
|||
**Is there a way to return a specific element?** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be much higher, probably the 2nd from the top. If you're modifying FAQs anyways, I'd suggest look at the existing entries and re-order them based on popularity with highest on the top.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reordered.
2bec234
to
81fe48d
Compare
docs/faq.md
Outdated
of EarlGrey being linked to more than once. Ensure that only the **Test Target** | ||
depends on *EarlGrey.framework* and EarlGrey.framework is embedded in the app under test (i.e. *$TEST_HOST*) from the | ||
test target's build phase. | ||
|
||
**How do I check whether an element exists in the UI hierarchy?** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Under How should I handle animations?, there's a code snippet that shows how to speed up animations:
UIApplication.sharedApplication().keyWindow?.layer.speed = 100
Could we change it to use the TestHelper instead?
https://github.com/google/EarlGrey/blob/master/EarlGrey/Common/GREYTestHelper.m
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
docs/ifaq.md
Outdated
@@ -0,0 +1,13 @@ | |||
#IFAQ - Infrequently Asked Questions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't render correctly:
https://github.com/tirodkar/EarlGrey/blob/7e5b64c693082b26628d481a1b8e39232474b0f3/docs/ifaq.md
Also are you planning on linking this file to README or from somewhere in FAQ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
README. Adding it.
docs/install-and-run.md
Outdated
## Prerequisites | ||
|
||
For EarlGrey to function properly, make sure the app under test has correct launch screen images present for all supported devices (see [iOS Developer Library, Launch Files](https://developer.apple.com/library/ios/documentation/UserExperience/Conceptual/MobileHIG/LaunchImages.html)). | ||
test.M |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
M?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
docs/install-and-run.md
Outdated
|
||
### CocoaPods installation | ||
For EarlGrey, we highly recommend [CocoaPods](http://cocoapods.org/pods/EarlGrey) as the best way to get started. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The cocoapods link should point to the section inside this file for Cocoapods installation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
docs/install-and-run.md
Outdated
configure_for_earlgrey(installer, PROJECT_NAME, TEST_TARGET, SCHEME_FILE) # EarlGrey Gem Call | ||
end | ||
``` | ||
The EarlGrey gem also copies the `EarlGrey.swift` file to your project directory if you're passing the `{swift: true}` parameter to the args for the configure_for_earlgrey() method. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Show code example for swift users. Majority will be using swift.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
docs/install-and-run.md
Outdated
Now you're ready to start testing with EarlGrey! | ||
If you need more control, review the available install options. | ||
Now you're ready to start testing with EarlGrey! | ||
If you need more control, review the available installation options in the `earlgrey gem`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why is earlgrey gem
highlighted as code here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed
docs/install-and-run.md
Outdated
|
||
`earlgrey help install` | ||
`earlgrey help install` | ||
|
||
### GitHub Installation | ||
|
||
In cases where CocoaPods is not compatible with your project, you can add EarlGrey manually to your Xcode project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't need to mention cocoapods not being compatible...Just say some like: if cocoapods or carthage don't work you then you can integrate manually.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"If CocoaPods or Carthage doesn't suit your use case, then you can add EarlGrey manually to your Xcode project."
docs/install-and-run.md
Outdated
|
||
### GitHub Installation | ||
|
||
In cases where CocoaPods is not compatible with your project, you can add EarlGrey manually to your Xcode project. | ||
|
||
#### Step 1: Generate EarlGrey.framework | ||
|
||
1. Download the source for EarlGrey and its dependencies. | ||
* Download EarlGrey's source code from the [Latest Release](https://github.com/google/EarlGrey/archive/1.0.0.zip) | ||
1. Download the source for EarlGrey. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How is this 1. different from 1. below? Can you please view the files in md viewer and fix all the rendering / layout issues?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed the extra 1.
docs/install-and-run.md
Outdated
|
||
#### Step 2: Add EarlGrey as a dependency of the project which contains your app under test | ||
|
||
1. Close **EarlGrey.xcodeproj** so that it is no longer open in any Xcode window. Once closed, drag **EarlGrey.xcodeproj** from its directory into your App’s project or workspace in Xcode. To verify this, you should find `EarlGrey` in the list of targets of your app in Xcode: | ||
1. Close **EarlGrey.xcodeproj** so that it is no longer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why the abrupt break in line after "no longer" ?
docs/install-and-run.md
Outdated
|
||
3. Add EarlGrey as a Target Dependency to the Test Target: | ||
``` | ||
**Project** → **Test Target** → **Build Phases** → **Link Binary With Libraries** → **+ (Add Sign)** → **EarlGrey.framework** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
** isn't bolding the texts
plz view in md viewer and fix such issues. I've spotted a lot of them already.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, ** doesn't work in code blocks. Removed em.
docs/install-and-run.md
Outdated
1. Download the source for EarlGrey and its dependencies. | ||
* Download EarlGrey's source code from the [Latest Release](https://github.com/google/EarlGrey/archive/1.0.0.zip) | ||
1. Download EarlGrey's source code from the | ||
[Latest Release](https://github.com/google/EarlGrey/releases/tag/1.8.0). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lets link to https://github.com/google/EarlGrey/releases instead, the latest will be on the top any ways otherwise we will have to keep updating this link
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@khandpur could we confirm this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1 to hao's idea
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor nits.
docs/faq.md
Outdated
@@ -1,5 +1,14 @@ | |||
# FAQ | |||
|
|||
**I did a fresh `git clone` of the EarlGreyExample CocoaPods Demo project followed by a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
He plans on getting it in for the next release so lets remove this? we might forget to not remove it.
README.md
Outdated
@@ -46,6 +46,7 @@ You can also start new discussions with us on our [Google group](https://groups. | |||
or request to join our [slack channel](https://googleoss.slack.com/messages/earlgrey). | |||
|
|||
* [FAQ](https://github.com/google/EarlGrey/tree/master/docs/faq.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FAQ - Frequently Asked Questions
|
||
```swift | ||
// Objective-C | ||
[GREYTestHelper enableFastAnimation]; | ||
``` | ||
|
||
If the above doesn't help, you can temporarily disable synchronization to work around an animation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: place the swift code example before objc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
No description provided.