Skip to content

Commit 71aa3a3

Browse files
committed
docs: fixes
1 parent 696e0cb commit 71aa3a3

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/02-configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ $api = new OpenWeatherMap('yourapikey', [
6969

7070
> [!IMPORTANT]
7171
> The [PHP API SDK](https://github.com/programmatordev/php-api-sdk) library was used to create the OpenWeatherMap PHP API.
72-
> To get to know about all available methods, make sure to check the documentation [here](https://github.com/programmatordev/php-api-sdk?tab=readme-ov-file#php-api-sdk).
72+
> To get to know about all the available methods, make sure to check the documentation [here](https://github.com/programmatordev/php-api-sdk?tab=readme-ov-file#php-api-sdk).
7373
7474
The following sections have examples of some of the most important methods,
7575
particularly related with the configuration of the client, cache and logger.
@@ -147,7 +147,7 @@ use ProgrammatorDev\OpenWeatherMap\OpenWeatherMap;
147147

148148
$api = new OpenWeatherMap('yourapikey');
149149

150-
$logger = new Logger('openweathermap');
150+
$logger = new Logger('api');
151151
$logger->pushHandler(new StreamHandler('/logs/api.log'));
152152

153153
$api->setLoggerBuilder(

docs/03-supported-apis.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
- [APIs](#apis)
44
- [One Call](#one-call)
55
- [getWeather](#getweather)
6-
- [getHistoryMoment](#gethistorymoment)
7-
- [getHistoryAggregate](#gethistoryaggregate)
6+
- [getWeatherByDate](#getweatherbydate)
7+
- [getWeatherSummaryByDate](#getweathersummarybydate)
88
- [Weather](#weather)
99
- [getCurrent](#getcurrent)
1010
- [getForecast](#getforecast)
@@ -28,7 +28,7 @@
2828
#### `getWeather`
2929

3030
```php
31-
getWeather(float $latitude, float $longitude): OneCall
31+
getWeather(float $latitude, float $longitude): Weather
3232
```
3333

3434
Get access to current weather, minute forecast for 1 hour, hourly forecast for 48 hours,
@@ -161,7 +161,7 @@ getByLocationName(string $locationName, int $numResults = 5): array
161161

162162
Get geographical coordinates (latitude, longitude) by using the name of the location (city name or area name).
163163

164-
Returns an array of [`Location`](05-entities.md#location) entities.
164+
Returns an array of [`Location`](05-entities.md#location) objects.
165165

166166
```php
167167
$locations = $api->geocoding()->getByLocationName('lisbon');
@@ -178,7 +178,7 @@ getByCoordinate(float $latitude, float $longitude, int $numResults = 5): array
178178

179179
Get name of the location (city name or area name) by using geographical coordinates (latitude, longitude).
180180

181-
Returns an array of [`Location`](05-entities.md#location) entities.
181+
Returns an array of [`Location`](05-entities.md#location) objects.
182182

183183
```php
184184
$locations = $api->geocoding()->getByCoordinate(50, 50);

0 commit comments

Comments
 (0)