Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
are-docs-informative
Advanced tools
Checks whether a documentation description introduces any new information.
Checks whether a documentation description introduces any new information.
npm i are-docs-informative
import { areDocsInformative } from "are-docs-informative";
areDocsInformative("The user id.", "userId"); // false
areDocsInformative("Retrieved user id.", "userId"); // true
The areDocsInformative
function can receive a third, optional parameter
aliases
The aliases
option allows indicating words as synonyms (aliases) of each other.
For example, with { aliases: { emoji: ["smiley", "winkey"] } }
, the following comment would be considered uninformative:
/** Default smiley/winkey. */
export const defaultSmiley = "🙂";
The default aliases
option is:
{
"a": ["an", "our"]
}
uselessWords
Words that are ignored when searching for one that adds meaning.
For example, with { uselessWords: ["our"] }
, the following comment would be considered uninformative:
/** Our text. */
export const text = ":)";
The default uselessWords
option is:
["a", "an", "i", "in", "of", "s", "the"]
See .github/CONTRIBUTING.md
, then .github/DEVELOPMENT.md
.
Thanks! 💖
Josh Goldberg 🔧 |
💙 This package is based on @JoshuaKGoldberg's template-typescript-node-package.
FAQs
Checks whether a documentation description introduces any new information.
The npm package are-docs-informative receives a total of 1,215,299 weekly downloads. As such, are-docs-informative popularity was classified as popular.
We found that are-docs-informative demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.