Skip to content

Commit 63d7188

Browse files
bryant1410SrinivasanTarget
authored andcommitted
Fix broken Markdown headings (#624)
1 parent bedf055 commit 63d7188

10 files changed

+28
-28
lines changed

archive/docs/How-to-propose-a-PR.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#A good pull-request should contain
1+
# A good pull-request should contain
22

33
### Change list
44

@@ -19,6 +19,6 @@ There should be provided more details about changes if it is necessary. If there
1919
can provide code samples which show the way they work and possible use cases. Also you can create [gists](https://gist.github.com)
2020
with pasted java code samples or put them at a PR description using markdown. About markdown please read [Mastering markdown](https://guides.github.com/features/mastering-markdown/) and [Writing on GitHub](https://help.github.com/categories/writing-on-github/)
2121

22-
#Pull-request template
22+
# Pull-request template
2323

2424
There is [PULL_REQUEST_TEMPLATE.md)](https://github.com/appium/java-client/blob/master/PULL_REQUEST_TEMPLATE.md) which should help you to make a good pull request.

archive/docs/How-to-report-an-issue.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
#Be sure that it is not a server-side problem if you are facing something that looks like a bug
1+
# Be sure that it is not a server-side problem if you are facing something that looks like a bug
22

33
The Appium Java client is the thin client which just sends requests and receives responces generally.
44
Be sure that this bug is not reported [here](https://github.com/appium/appium/issues) and/or there is
55
no progress on this issue.
66

7-
#The good issue report should contain
7+
# The good issue report should contain
88

99
### Description
1010

@@ -42,9 +42,9 @@ There should be created a [gist](https://gist.github.com) which is a paste of yo
4242
If you are reporting a bug, _always_ include Appium logs as linked gists! It helps to define the problem correctly and clearly.
4343

4444

45-
#Issue template
45+
# Issue template
4646
There is [ISSUE_TEMPLATE.md](https://github.com/appium/java-client/blob/master/ISSUE_TEMPLATE.md) which should help you to make a good issue report.
4747

48-
#... And don't say that you weren't warned.
48+
# ... And don't say that you weren't warned.
4949

5050
If a report is not readable and/or there is no response from a reporter and some important details are needed then the issue will be closed after some time.

docs/Functions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Appium java client has some features based on [Java 8 Functional interfaces](https://www.oreilly.com/learning/java-8-functional-interfaces).
22

3-
#Conditions
3+
# Conditions
44

55
```java
66
io.appium.java_client.functions.AppiumFunction
@@ -58,7 +58,7 @@ private final AppiumFunction<Pattern, WebDriver> contextFunction = input -> {
5858
};
5959
```
6060

61-
##using one function as pre-condition
61+
## using one function as pre-condition
6262

6363
```java
6464
@Test public void tezt() {
@@ -70,7 +70,7 @@ private final AppiumFunction<Pattern, WebDriver> contextFunction = input -> {
7070
}
7171
```
7272

73-
##using one function as post-condition
73+
## using one function as post-condition
7474

7575
```java
7676
import org.openqa.selenium.support.ui.FluentWait;
@@ -85,7 +85,7 @@ import org.openqa.selenium.support.ui.Wait;
8585
}
8686
```
8787

88-
#Touch action supplier
88+
# Touch action supplier
8989

9090
[About touch actions](https://github.com/appium/java-client/blob/master/docs/Touch-actions.md)
9191

@@ -96,7 +96,7 @@ create gesture libraries/utils using suppliers. Appium java client provides this
9696
io.appium.java_client.functions.ActionSupplier
9797
```
9898

99-
##Samples
99+
## Samples
100100

101101
```java
102102
private final ActionSupplier<TouchAction> horizontalSwipe = () -> {

docs/How-to-propose-a-PR.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#A good pull-request should contain
1+
# A good pull-request should contain
22

33
### Change list
44

@@ -19,6 +19,6 @@ There should be provided more details about changes if it is necessary. If there
1919
can provide code samples which show the way they work and possible use cases. Also you can create [gists](https://gist.github.com)
2020
with pasted java code samples or put them at a PR description using markdown. About markdown please read [Mastering markdown](https://guides.github.com/features/mastering-markdown/) and [Writing on GitHub](https://help.github.com/categories/writing-on-github/)
2121

22-
#Pull-request template
22+
# Pull-request template
2323

2424
There is [PULL_REQUEST_TEMPLATE.md)](https://github.com/appium/java-client/blob/master/PULL_REQUEST_TEMPLATE.md) which should help you to make a good pull request.

docs/How-to-report-an-issue.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
#Be sure that it is not a server-side problem if you are facing something that looks like a bug
1+
# Be sure that it is not a server-side problem if you are facing something that looks like a bug
22

33
The Appium Java client is the thin client which just sends requests and receives responces generally.
44
Be sure that this bug is not reported [here](https://github.com/appium/appium/issues) and/or there is
55
no progress on this issue.
66

7-
#The good issue report should contain
7+
# The good issue report should contain
88

99
### Description
1010

@@ -42,9 +42,9 @@ There should be created a [gist](https://gist.github.com) which is a paste of yo
4242
If you are reporting a bug, _always_ include Appium logs as linked gists! It helps to define the problem correctly and clearly.
4343

4444

45-
#Issue template
45+
# Issue template
4646
There is [ISSUE_TEMPLATE.md](https://github.com/appium/java-client/blob/master/ISSUE_TEMPLATE.md) which should help you to make a good issue report.
4747

48-
#... And don't say that you weren't warned.
48+
# ... And don't say that you weren't warned.
4949

5050
If a report is not readable and/or there is no response from a reporter and some important details are needed then the issue will be closed after some time.

docs/Installing-the-project.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
#Requirements
1+
# Requirements
22

33
Firstly you should install appium server. [Appium getting started](http://appium.io/getting-started.html). The version 1.6.3 or greater is recommended.
44

55
Since version 5.x there many features based on Java 8. So we recommend to install JDK SE 8 and provide that source compatibility.
66

7-
#Maven
7+
# Maven
88

99
Add the following to pom.xml:
1010

@@ -40,7 +40,7 @@ If it is necessary to change the version of Selenium then you can configure pom.
4040
</dependency>
4141
```
4242

43-
#Gradle
43+
# Gradle
4444

4545
Add the following to build.gradle:
4646

docs/Tech-stack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Also tech stack includes [Spring framework](https://projects.spring.io/spring-fr
1212
It is the client framework. It is the thin client which just sends requests to Appium server and receives responses. Also it has some
1313
high-level features which were designed to simplify user's work.
1414

15-
#It supports:
15+
# It supports:
1616

1717
![](https://cloud.githubusercontent.com/assets/4927589/21467612/4b6b3f70-ca05-11e6-9a31-d3820e98dac6.png)
1818
![](https://cloud.githubusercontent.com/assets/4927589/21467614/73883828-ca05-11e6-846d-3ed8847a7e08.jpg)

docs/The-starting-of-an-Android-app.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ capabilities);
6565
```
6666

6767

68-
##If it needs to start browser then
68+
## If it needs to start browser then
6969

7070
This capability should be used
7171

@@ -75,7 +75,7 @@ capabilities.setCapability(MobileCapabilityType.BROWSER_NAME, MobileBrowserType.
7575
//is your choice
7676
```
7777

78-
##There are three automation types
78+
## There are three automation types
7979

8080
```java
8181
capabilities.setCapability(MobileCapabilityType.AUTOMATION_NAME, AutomationName.SELENDROID);

docs/The-starting-of-an-iOS-app.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,13 @@ new URL("http://target_ip:used_port/wd/hub"), //if it needs to use locally start
6868
capabilities);
6969
```
7070

71-
##If it needs to start browser then
71+
## If it needs to start browser then
7272

7373
```java
7474
capabilities.setCapability(MobileCapabilityType.BROWSER_NAME, MobileBrowserType.SAFARI);
7575
```
7676

77-
##There are two automation types
77+
## There are two automation types
7878

7979
Default iOS Automation (v < iOS 10.x) does not require any specific capability. However you can
8080
```java

docs/Touch-actions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Appium server side provides abilities to emulate touch actions. It is possible construct single, complex and multiple touch actions.
22

3-
#How to use a single touch action
3+
# How to use a single touch action
44

55
```java
66
import io.appium.java_client.TouchAction;
@@ -12,7 +12,7 @@ new TouchAction(driver)
1212
.findElementById("io.appium.android.apis:id/start")).perform();
1313
```
1414

15-
#How to construct complex actions
15+
# How to construct complex actions
1616

1717
```java
1818
import io.appium.java_client.TouchAction;
@@ -24,7 +24,7 @@ TouchAction swipe = new TouchAction(driver).press(images.get(2), -10, center.y -
2424
swipe.perform();
2525
```
2626

27-
#How to construct multiple touch action.
27+
# How to construct multiple touch action.
2828

2929
```java
3030
import io.appium.java_client.TouchAction;

0 commit comments

Comments
 (0)