Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): fix typos #1536

Merged
merged 1 commit into from
Jan 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/CalDAV/Backend/BackendInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ public function deleteCalendarObject($calendarId, $objectUri);
*
* This default may well be good enough for personal use, and calendars
* that aren't very large. But if you anticipate high usage, big calendars
* or high loads, you are strongly adviced to optimize certain paths.
* or high loads, you are strongly advised to optimize certain paths.
*
* The best way to do so is override this method and to optimize
* specifically for 'common filters'.
Expand Down
2 changes: 1 addition & 1 deletion lib/CalDAV/Backend/NotificationSupport.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ interface NotificationSupport extends BackendInterface
public function getNotificationsForPrincipal($principalUri);

/**
* This deletes a specific notifcation.
* This deletes a specific notification.
*
* This may be called by a client once it deems a notification handled.
*
Expand Down
4 changes: 2 additions & 2 deletions lib/CalDAV/Backend/PDO.php
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ public function getCalendarsForUser($principalUri)
//$stmt2 = $this->pdo->prepare('SELECT principaluri FROM ' . $this->calendarInstancesTableName . ' WHERE access = 1 AND id = ?');
//$stmt2->execute([$row['id']]);

// read-only is for backwards compatbility. Might go away in
// read-only is for backwards compatibility. Might go away in
// the future.
$calendar['read-only'] = \Sabre\DAV\Sharing\Plugin::ACCESS_READ === (int) $row['access'];
}
Expand Down Expand Up @@ -730,7 +730,7 @@ public function deleteCalendarObject($calendarId, $objectUri)
*
* This default may well be good enough for personal use, and calendars
* that aren't very large. But if you anticipate high usage, big calendars
* or high loads, you are strongly adviced to optimize certain paths.
* or high loads, you are strongly advised to optimize certain paths.
*
* The best way to do so is override this method and to optimize
* specifically for 'common filters'.
Expand Down
2 changes: 1 addition & 1 deletion lib/CalDAV/Calendar.php
Original file line number Diff line number Diff line change
Expand Up @@ -435,7 +435,7 @@ public function getSyncToken()
* return null.
*
* The limit is 'suggestive'. You are free to ignore it.
* TODO: RFC6578 Setion 3.7 says that the server must fail when the server
* TODO: RFC6578 Section 3.7 says that the server must fail when the server
* cannot truncate according to the limit, so it may not be just suggestive.
*
* @param string $syncToken
Expand Down
4 changes: 2 additions & 2 deletions lib/CalDAV/Notifications/Node.php
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public function getName()
/**
* Returns the etag for the notification.
*
* The etag must be surrounded by litteral double-quotes.
* The etag must be surrounded by literal double-quotes.
*
* @return string
*/
Expand Down Expand Up @@ -101,7 +101,7 @@ public function delete()
/**
* Returns the owner principal.
*
* This must be a url to a principal, or null if there's no owner
* This must be an url to a principal, or null if there's no owner
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess there is "discussion" about "an url" or "a URL", when pronouncing each letter then it is "a"
"a U, an R and an L". But I will leave this change here - it does not matter either way.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good explanation. I did not realized that both variants exist and I should leave it as it is.

*
* @return string|null
*/
Expand Down
2 changes: 1 addition & 1 deletion lib/CalDAV/Plugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -913,7 +913,7 @@ protected function validateICalendar(&$data, $path, &$modified, RequestInterface
}

/**
* This method is triggered whenever a subsystem reqeuests the privileges
* This method is triggered whenever a subsystem requests the privileges
* that are supported on a particular node.
*/
public function getSupportedPrivilegeSet(INode $node, array &$supportedPrivilegeSet)
Expand Down
2 changes: 1 addition & 1 deletion lib/CalDAV/SharingPlugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ public function propFindLate(DAV\PropFind $propFind, DAV\INode $node)
}

/**
* This method is trigged when a user attempts to update a node's
* This method is triggered when a user attempts to update a node's
* properties.
*
* A previous draft of the sharing spec stated that it was possible to use
Expand Down
2 changes: 1 addition & 1 deletion lib/CalDAV/Xml/Request/CalendarMultiGetReport.php
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class CalendarMultiGetReport implements XmlDeserializable
public $expand = null;

/**
* The mimetype of the content that should be returend. Usually
* The mimetype of the content that should be returned. Usually
* text/calendar.
*
* @var string
Expand Down
2 changes: 1 addition & 1 deletion lib/CalDAV/Xml/Request/CalendarQueryReport.php
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class CalendarQueryReport implements XmlDeserializable
public $expand = null;

/**
* The mimetype of the content that should be returend. Usually
* The mimetype of the content that should be returned. Usually
* text/calendar.
*
* @var string
Expand Down
4 changes: 2 additions & 2 deletions lib/CardDAV/Backend/BackendInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ public function deleteAddressBook($addressBookId);
* * size - The size of the card in bytes.
*
* If these last two properties are provided, less time will be spent
* calculating them. If they are specified, you can also ommit carddata.
* calculating them. If they are specified, you can also omit carddata.
* This may speed up certain requests, especially with large cards.
*
* @param mixed $addressbookId
Expand All @@ -98,7 +98,7 @@ public function deleteAddressBook($addressBookId);
public function getCards($addressbookId);

/**
* Returns a specfic card.
* Returns a specific card.
*
* The same set of properties must be returned as with getCards. The only
* exception is that 'carddata' is absolutely required.
Expand Down
2 changes: 1 addition & 1 deletion lib/CardDAV/Backend/PDO.php
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ public function deleteAddressBook($addressBookId)
* * size - The size of the card in bytes.
*
* If these last two properties are provided, less time will be spent
* calculating them. If they are specified, you can also ommit carddata.
* calculating them. If they are specified, you can also omit carddata.
* This may speed up certain requests, especially with large cards.
*
* @param mixed $addressbookId
Expand Down
2 changes: 1 addition & 1 deletion lib/CardDAV/Xml/Request/AddressBookQueryReport.php
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ class AddressBookQueryReport implements XmlDeserializable
public $test;

/**
* The mimetype of the content that should be returend. Usually
* The mimetype of the content that should be returned. Usually
* text/vcard.
*
* @var string
Expand Down
2 changes: 1 addition & 1 deletion lib/DAV/Auth/Backend/PDOBasicAuth.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class PDOBasicAuth extends AbstractBasic
* Digest prefix:
* if the backend you are using for is prefixing
* your password hashes set this option to your prefix to
* cut it off before verfiying.
* cut it off before verifying.
*
* @var string
*/
Expand Down
2 changes: 1 addition & 1 deletion lib/DAV/Browser/Plugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,7 @@ public function htmlActionsPanel(DAV\INode $node, &$output, $path)

/**
* This method takes a path/name of an asset and turns it into url
* suiteable for http access.
* suitable for http access.
*
* @param string $assetName
*
Expand Down
2 changes: 1 addition & 1 deletion lib/DAV/Exception/InvalidSyncToken.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
/**
* InvalidSyncToken.
*
* This exception is emited for the {DAV:}valid-sync-token pre-condition, as
* This exception is emitted for the {DAV:}valid-sync-token pre-condition, as
* defined in rfc6578, section 3.2.
*
* http://tools.ietf.org/html/rfc6578#section-3.2
Expand Down
2 changes: 1 addition & 1 deletion lib/DAV/Exception/TooManyMatches.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
/**
* TooManyMatches.
*
* This exception is emited for the {DAV:}number-of-matches-within-limits
* This exception is emitted for the {DAV:}number-of-matches-within-limits
* post-condition, as defined in rfc6578, section 3.2.
*
* http://tools.ietf.org/html/rfc6578#section-3.2
Expand Down
2 changes: 1 addition & 1 deletion lib/DAV/INodeByPath.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
*
* This interface adds a tiny bit of functionality to collections.
*
* Getting a node that is deep in the tree normally requires going trough each parent node
* Getting a node that is deep in the tree normally requires going through each parent node
* which can cause a significant performance overhead.
*
* Implementing this interface allows solving this overhead by directly jumping to the target node.
Expand Down
2 changes: 1 addition & 1 deletion lib/DAV/Sharing/Plugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ public function httpPost(RequestInterface $request, ResponseInterface $response)
}

/**
* This method is triggered whenever a subsystem reqeuests the privileges
* This method is triggered whenever a subsystem requests the privileges
* hat are supported on a particular node.
*
* We need to add a number of privileges for scheduling purposes.
Expand Down
2 changes: 1 addition & 1 deletion lib/DAVACL/Plugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -716,7 +716,7 @@ public function getPrincipalByUri($uri)
* @param array $requestedProperties this is the list of properties to
* return for every match
* @param string $collectionUri the principal collection to search on.
* If this is ommitted, the standard
* If this is omitted, the standard
* principal collection-set will be used
* @param string $test "allof" to use AND to search the
* properties. 'anyof' for OR.
Expand Down
2 changes: 1 addition & 1 deletion lib/DAVACL/PrincipalBackend/PDO.php
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ public function __construct(\PDO $pdo)
* return any additional properties if you wish so. Common properties are:
* {DAV:}displayname
* {http://sabredav.org/ns}email-address - This is a custom SabreDAV
* field that's actualy injected in a number of other properties. If
* field that's actually injected in a number of other properties. If
* you have an email address, use this property.
*
* @param string $prefixPath
Expand Down
2 changes: 1 addition & 1 deletion lib/DAVACL/Xml/Property/Principal.php
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ public function toHtml(HtmlOutputHelper $html)
/**
* The deserialize method is called during xml parsing.
*
* This method is called staticly, this is because in theory this method
* This method is called statically, this is because in theory this method
* may be used as a type of constructor, or factory method.
*
* Often you want to return an instance of the current class, but you are
Expand Down
2 changes: 1 addition & 1 deletion tests/Sabre/CalDAV/Backend/AbstractPDOTestCase.php
Original file line number Diff line number Diff line change
Expand Up @@ -956,7 +956,7 @@ public function testGetChanges()

$result = $backend->getChangesForCalendar($id, $currentToken, 1, 2);

// according to RFC6578 Section 3.6, the result including syncToken must correpsond to one time (syncToken=8 here)
// according to RFC6578 Section 3.6, the result including syncToken must correspond to one time (syncToken=8 here)
self::assertEquals([
'syncToken' => 8,
'modified' => [],
Expand Down
2 changes: 1 addition & 1 deletion tests/Sabre/CalDAV/Backend/MockSharing.php
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public function getNotificationsForPrincipal($principalUri)
}

/**
* This deletes a specific notifcation.
* This deletes a specific notification.
*
* This may be called by a client once it deems a notification handled.
*
Expand Down
2 changes: 1 addition & 1 deletion tests/Sabre/CalDAV/Issue203Test.php
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ public function testIssue203()
],
];

// try to match agains $expectedEvents array
// try to match against $expectedEvents array
foreach ($expectedEvents as $expectedEvent) {
$matching = false;

Expand Down
4 changes: 2 additions & 2 deletions tests/Sabre/CardDAV/Backend/Mock.php
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ public function deleteAddressBook($addressBookId)
* * size - The size of the card in bytes.
*
* If these last two properties are provided, less time will be spent
* calculating them. If they are specified, you can also ommit carddata.
* calculating them. If they are specified, you can also omit carddata.
* This may speed up certain requests, especially with large cards.
*
* @param mixed $addressBookId
Expand Down Expand Up @@ -150,7 +150,7 @@ public function getCards($addressBookId)
}

/**
* Returns a specfic card.
* Returns a specific card.
*
* The same set of properties must be returned as with getCards. The only
* exception is that 'carddata' is absolutely required.
Expand Down
2 changes: 1 addition & 1 deletion tests/Sabre/DAV/Auth/Backend/Mock.php
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public function check(RequestInterface $request, ResponseInterface $response)
* This method is called when a user could not be authenticated, and
* authentication was required for the current request.
*
* This gives you the oppurtunity to set authentication headers. The 401
* This gives you the opportunity to set authentication headers. The 401
* status code will already be set.
*
* In this case of Basic Auth, this would for example mean that the
Expand Down
2 changes: 1 addition & 1 deletion tests/Sabre/DAV/HttpPutTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ public function testFinderPutSuccess()
}

/**
* Same as the last one, but in this case we're mimicing a failed request.
* Same as the last one, but in this case we're mimicking a failed request.
*
* @depends testFinderPutSuccess
*/
Expand Down
2 changes: 1 addition & 1 deletion tests/Sabre/DAV/Sync/MockSyncCollection.php
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ function ($item) {

if ($limit) {
// If there's a limit, we may need to cut things off.
// This alghorithm is weird and stupid, but it works.
// This algorithm is weird and stupid, but it works.
$left = $limit - (count($modified) + count($deleted));
if ($left > 0) {
continue;
Expand Down