Skip to content

Commit

Permalink
Update debug logging in documentation; add changelog entry
Browse files Browse the repository at this point in the history
  • Loading branch information
Xymph committed Sep 1, 2021
1 parent 3534bb0 commit 64d4970
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ and [Keep a Changelog](http://keepachangelog.com/).
### Changed

- Centralized API communication checks in `WikiPage::request()` ([#136])
- Centralized debug logging of API requests/responses in `WikiPage::request()` ([#139])
- Added additional context to `README.md` ([#127])
- Added semi-linear merge recommendation to `GOVERNANCE.md` ([#130])

Expand Down Expand Up @@ -211,3 +212,4 @@ and may require changes in applications that invoke these methods:_
[#135]: https://github.com/hamstar/Wikimate/pull/135
[#136]: https://github.com/hamstar/Wikimate/pull/136
[#138]: https://github.com/hamstar/Wikimate/pull/138
[#139]: https://github.com/hamstar/Wikimate/pull/139
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ You should get a meaningful error message if the authentication fails.

Instead of using echo statements, you can enable/disable debugging
with the `$wiki->debugMode($boolean)` method.
Currently only output from the logon process is printed for debugging.
Debug logging is printed to [standard output](https://en.wikipedia.org/wiki/Standard_output)
and includes API requests/responses as well as retry messages for lag errors.

Assuming you were able to log in, you're now ready to fully use the API.

Expand Down
3 changes: 2 additions & 1 deletion USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ You should get a meaningful error message if the authentication fails.

Instead of using echo statements, you can enable/disable debugging
with the `$wiki->debugMode($boolean)` method.
Currently only output from the logon process is printed for debugging.
Debug logging is printed to [standard output](https://en.wikipedia.org/wiki/Standard_output)
and includes API requests/responses as well as retry messages for lag errors.

Assuming you were able to log in, you're now ready to fully use the API.
The next sections provide example code for several common tasks.
Expand Down

0 comments on commit 64d4970

Please sign in to comment.