Skip to content

Commit

Permalink
chore: grammatical issues in comments fixed (#210)
Browse files Browse the repository at this point in the history
  • Loading branch information
hisorange authored Dec 7, 2023
2 parents 86c581e + 88120b1 commit 82e850c
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion src/Contracts/ParserInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
interface ParserInterface
{
/**
* Get a result object from the current visitors user agent string.
* Get a result object from the current visitor user agent string.
*
* @return ResultInterface
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Contracts/PayloadInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public function setValue(string $key, $value): void;

/**
* Get a value if exists in the data schema,
* returns null if the key does not exists.
* returns null if the key does not exist.
*
* @param string $key Temporary data key.
*
Expand Down
24 changes: 12 additions & 12 deletions src/Contracts/ResultInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,21 +26,21 @@ public function __construct(array $result);
public function userAgent(): string;

/**
* Is this a mobile device.
* Is this a mobile device?
*
* @return bool
*/
public function isMobile(): bool;

/**
* Is this a tablet device.
* Is this a tablet device?
*
* @return bool
*/
public function isTablet(): bool;

/**
* Is this a desktop computer.
* Is this a desktop computer?
*
* @return bool
*/
Expand All @@ -54,7 +54,7 @@ public function isDesktop(): bool;
public function deviceType(): string;

/**
* Is this a crawler / bot.
* Is this a crawler / bot?
*
* @return bool
*/
Expand Down Expand Up @@ -89,7 +89,7 @@ public function isOpera(): bool;
public function isSafari(): bool;

/**
* Is this browser an Microsoft Edge?
* Is this browser a Microsoft Edge?
*
* @return bool
*/
Expand All @@ -103,14 +103,14 @@ public function isEdge(): bool;
public function isIE(): bool;

/**
* Is this browser an android in app browser?
* Is this browser an android in-app browser?
*
* @return bool
*/
public function isInApp(): bool;

/**
* Is this an Internet Explorer X (or lower version).
* Is this an Internet Explorer X (or lower version)?
*
* @param integer $version
* @param string $operator
Expand All @@ -120,7 +120,7 @@ public function isInApp(): bool;
public function isIEVersion(int $version, string $operator = '='): bool;

/**
* Build a human readable browser name: Internet Explorer 7, Firefox 3.6
* Build a human-readable browser name: Internet Explorer 7, Firefox 3.6
*
* @return string
*/
Expand All @@ -134,7 +134,7 @@ public function browserName(): string;
public function browserFamily(): string;

/**
* Build human readable browser version. (cuts the trailing .0 parts)
* Build a human-readable browser version. (Cuts the trailing .0 parts)
*
* @return string
*/
Expand Down Expand Up @@ -169,7 +169,7 @@ public function browserVersionPatch(): int;
public function browserEngine(): string;

/**
* Operating system's human friendly name like Windows XP, MacOS 10.
* Operating system's human-friendly name like Windows XP, macOS 10.
*
* @return string
*/
Expand All @@ -183,7 +183,7 @@ public function platformName(): string;
public function platformFamily(): string;

/**
* Build human readable os version. (cuts the trailing .0 parts)
* Build a human-readable os version. (cuts the trailing .0 parts)
*
* @return string
*/
Expand Down Expand Up @@ -225,7 +225,7 @@ public function isWindows(): bool;
public function isLinux(): bool;

/**
* Is this a mac operating system?
* Is this a Mac operating system?
*
* @return bool
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Parser.php
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ public function parse(string $agent): ResultInterface
$key = $this->makeHashKey($agent);

if (!isset($this->runtime[$key])) {
// In standalone mode You can run the parser without cache.
// In standalone mode, You can run the parser without a cache.
if ($this->cache !== null) {
$result = $this->cache->remember(
$key,
Expand Down
2 changes: 1 addition & 1 deletion src/Payload.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
use hisorange\BrowserDetect\Contracts\PayloadInterface;

/**
* This class is passed down in the pipeline
* This class is passed down in the pipeline,
* and each stage makes the changes on this
* state carrier object.
*
Expand Down
2 changes: 1 addition & 1 deletion src/Result.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/**
* The object is used for safely accessing the
* result of the parsing, this is necessary
* to allow us to change the implementaion
* to allow us to change the implementation
* behind the values.
*
* @package hisorange\BrowserDetect
Expand Down
2 changes: 1 addition & 1 deletion src/ServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ function ($fn) {
}

/**
* Only binding can occure here!
* Only binding can occur here!
*
* @inheritdoc
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Stages/BrowserDetect.php
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public function __invoke(PayloadInterface $payload): ResultInterface
$payload->setValue('isEdge', true);
}

// Human readable browser version.
// Human-readable browser version.
$payload->setValue(
'browserVersion',
$this->trimVersion(
Expand All @@ -94,7 +94,7 @@ public function __invoke(PayloadInterface $payload): ResultInterface
$payload->getValue('browserVersion')
));

// Human readable platform version.
// Human-readable platform version.
$payload->setValue(
'platformVersion',
$this->trimVersion(
Expand Down
2 changes: 1 addition & 1 deletion src/Stages/UAParser.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
use hisorange\BrowserDetect\Contracts\PayloadInterface;

/**
* Main parser to get the most of the info about the browser and it's operating system.
* Main parser to get the most of the info about the browser, and it's an operating system.
*
* @package hisorange\BrowserDetect\Stages
*/
Expand Down

0 comments on commit 82e850c

Please sign in to comment.