Skip to content

Commit 9c3e085

Browse files
authored
Merge pull request Alexia#30 from bryant1410/master
Fix broken headings in Markdown files
2 parents 7f6cf63 + 55f5c8d commit 9c3e085

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
#Introduction
2-
####What is PHP 7 Migration Assistant Report(MAR)?
1+
# Introduction
2+
#### What is PHP 7 Migration Assistant Report(MAR)?
33
PHP 7 MAR, or just "php7mar", is a command line utility to generate reports on existing PHP 5 code to assist developers in porting their code quickly to PHP 7. It will run against invididual files or entire project folders. Reports contain line numbers, issues noted, and suggested fixes along with documentation links.
44

5-
####Will php7mar automatically fix my code?
5+
#### Will php7mar automatically fix my code?
66
No, php7mar does implement a full lexer to determine code changes and can not determine the intent of the code. It uses lexer tokenizing, string matching, and regular expressions to find syntax changes that may cause issues when porting code to PHP 7. As well, it will detect code snippets in comments and report them as it can not distinguish it as commented code.
77

8-
####What has changed in PHP 7? (Read This!)
8+
#### What has changed in PHP 7? (Read This!)
99
If you are currently unfamiliar with what will change moving to PHP 7 then read the [UPGRADING file in the current master branch of php-src](https://github.com/php/php-src/blob/PHP-7.0.0/UPGRADING). Understanding these changes is important to reading the reports generated by php7mar.
1010

11-
####Does it handle very poorly styled code?
11+
#### Does it handle very poorly styled code?
1212
Very poorly styled code will not parse well, but assuming there is at least some structure to the code style it should still parse. If the code is entirely too poorly formatted there are several web sites that can be used to clean up source code.
1313

1414
* http://www.phpformatter.com/ (Does not support PHP 5.4 [] array syntax.)
1515
* http://phpbeautifier.com/
1616
* http://phpcodecleaner.com/
1717

18-
#Usage
18+
# Usage
1919
First, start by downloading or cloning this repository. It does not need to be placed inside the folder containing the source code.
2020

2121
To begin, type on the command line:
@@ -38,7 +38,7 @@ Give a try, use the included `testcases.php` to generate a report:
3838

3939
php mar.php -f="testcases.php"
4040

41-
##Available Options:
41+
## Available Options:
4242
**-f**
4343
```
4444
Path to the file or folder to run against.
@@ -74,12 +74,12 @@ Give a try, use the included `testcases.php` to generate a report:
7474
*Example: --php="/path/to/php/binary/php"*
7575
```
7676

77-
#Test Types
78-
##Critical
77+
# Test Types
78+
## Critical
7979
Critical tests look for issues that will cause broken code, compilation errors, or otherwise create code that works in unintended manors.
8080

81-
##Nuance
81+
## Nuance
8282
Nuance tests look for issues that might cause silent underisable code behavior. These tests can report many false positives as they can not determine the intent of the code being checked.
8383

84-
##Syntax
84+
## Syntax
8585
A basic command line based syntax checker that checks all files for standard syntax issues. This is useful for double checking work after making many mass find and replace operations. Please note that syntax checking adds a significant increase to processing time especially for large code bases. To run without syntax checking use the -t option and omit syntax; -t="critical,nuance"

STYLE.md

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

3-
#General Style
3+
# General Style
44
* Code SHOULD generally follow PSR-1 except where contradicted below.
55
* Code MUST use the One True Brace style variant of K&R. See: http://en.wikipedia.org/wiki/Indent_style#Variant:_1TBS
66
* Code MUST use one tab character per ident level.
77

8-
#Function, Method, Class, and Namespaces
8+
# Function, Method, Class, and Namespaces
99
* Functions, methods, classes, and namespaces MUST use camelCased names.
1010
* In the instance of an acronym it MUST be converted to lower case.

0 commit comments

Comments
 (0)