Skip to content
This repository has been archived by the owner on Jan 3, 2024. It is now read-only.

Commit

Permalink
[dev] Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
robertrossmann committed Mar 25, 2015
1 parent 80c2e02 commit b116cf0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,7 @@ This library follows [PSR-2](http://www.php-fig.org/psr/psr-2) coding style. Whe
To check your code, run:
```
composer install
./vendor/bin/phpcs --standard=PSR2 --ignore=vendor/*,docs/* -p .
make lint
# Or...
vendor/bin/phpcs --standard=PSR2 -p Dreamscapes
```
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ All methods are named as close to the original functions as possible, although w
1. The method names are **camelCased** instead of **underscore_based**
1. All methods return data by returning them and not by populating variables passed as references
1. Some functions are not implemented (usually because they are redundant)
1. Exceptions are thrown if the ldap protocol encounters an error, although standard PHP warnings and errors are not suppressed in most cases (still considering this)
1. Exceptions are thrown if the ldap protocol encounters an error, and standard PHP warnings and errors are suppressed in most cases

### Example
```php
Expand Down Expand Up @@ -75,7 +75,7 @@ Online API documentation is available [here](http://dreamscapes.github.io/Ldap-C
git clone https://github.com/Dreamscapes/Ldap-Core.git
cd Ldap-Core
composer install
php vendor/bin/phpdoc
make docs
```
Documentation is now available at *./docs/index.html*

Expand Down

0 comments on commit b116cf0

Please sign in to comment.