mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
docs: Fix language
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
This commit is contained in:
@@ -374,7 +374,7 @@ export class DataAccessorBasedStore implements ResourceStore {
|
||||
* then the other URI MUST NOT correspond to another resource."
|
||||
* https://solid.github.io/specification/protocol#uri-slash-semantics
|
||||
*
|
||||
* First the identifier gets requested and if no result is found
|
||||
* First the identifier gets requested. If no result is found,
|
||||
* the identifier with differing trailing slash is requested.
|
||||
*
|
||||
* @param identifier - Identifier that needs to be checked.
|
||||
@@ -452,7 +452,7 @@ export class DataAccessorBasedStore implements ResourceStore {
|
||||
|
||||
/**
|
||||
* Write the given resource to the DataAccessor. Metadata will be updated with necessary triples.
|
||||
* In case of containers `handleContainerData` will be used to verify the data.
|
||||
* For containers, `handleContainerData` will be used to verify the data.
|
||||
*
|
||||
* @param identifier - Identifier of the resource.
|
||||
* @param representation - Corresponding Representation.
|
||||
@@ -590,8 +590,8 @@ export class DataAccessorBasedStore implements ResourceStore {
|
||||
}
|
||||
|
||||
/**
|
||||
* Clean http Slug to be compatible with the server. Makes sure there are no unwanted characters
|
||||
* e.g.: cleanslug('&%26') returns '%26%26'
|
||||
* Clean http Slug to be compatible with the server. Makes sure there are no unwanted characters,
|
||||
* e.g., cleanslug('&%26') returns '%26%26'
|
||||
*
|
||||
* @param slug - the slug to clean
|
||||
*/
|
||||
@@ -636,7 +636,7 @@ export class DataAccessorBasedStore implements ResourceStore {
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the given metadata represents a (potential) container,
|
||||
* Checks whether the given metadata represents a (potential) container,
|
||||
* based on the metadata.
|
||||
*
|
||||
* @param metadata - Metadata of the (new) resource.
|
||||
|
||||
@@ -5,7 +5,7 @@ import type { ResourceIdentifier } from '../http/representation/ResourceIdentifi
|
||||
*/
|
||||
export interface ResourceSet {
|
||||
/**
|
||||
* Check if a resource exists in this ResourceSet.
|
||||
* Checks whether a resource exists in this ResourceSet.
|
||||
*
|
||||
* @param identifier - Identifier of resource to check.
|
||||
*
|
||||
|
||||
@@ -162,7 +162,7 @@ export function matchesMediaPreferences(type: string, preferred?: ValuePreferenc
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the given two media types/ranges match each other.
|
||||
* Checks whether the given two media types/ranges match each other.
|
||||
* Takes wildcards into account.
|
||||
*
|
||||
* @param mediaA - Media type to match.
|
||||
|
||||
@@ -12,7 +12,7 @@ export interface KeyValueStorage<TKey, TValue> {
|
||||
get: (key: TKey) => Promise<TValue | undefined>;
|
||||
|
||||
/**
|
||||
* Checks if there is a value stored for the given key.
|
||||
* Checks whether there is a value stored for the given key.
|
||||
*
|
||||
* @param identifier - Identifier to check.
|
||||
*/
|
||||
|
||||
@@ -201,7 +201,7 @@ export class BaseFileIdentifierMapper implements FileIdentifierMapper {
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the given relative path is valid.
|
||||
* Check whether the given relative path is valid.
|
||||
*
|
||||
* @param path - A relative path, as generated by {@link getRelativePath}.
|
||||
* @param identifier - A resource identifier.
|
||||
|
||||
@@ -34,9 +34,9 @@ export interface FileIdentifierMapper {
|
||||
mapFilePathToUrl: (filePath: string, isContainer: boolean) => Promise<ResourceLink>;
|
||||
/**
|
||||
* Maps the given resource identifier / URL to a file path.
|
||||
* Determines the content-type if no content-type was provided by finding the corresponding file.
|
||||
* If there is no corresponding file a file path will be generated.
|
||||
* For containers the content-type input gets ignored.
|
||||
* Determines the content-type, if no content-type was provided, by finding the corresponding file.
|
||||
* If there is no corresponding file, a file path will be generated.
|
||||
* For containers, the content-type input gets ignored.
|
||||
*
|
||||
* @param identifier - The input identifier.
|
||||
* @param isMetadata - If we are mapping the metadata of the resource instead of its data.
|
||||
|
||||
Reference in New Issue
Block a user