Always provide complete, clear, and contextually rich documentation for all public APIs. Documentation should: 1. Use proper grammar and clear wording
Always provide complete, clear, and contextually rich documentation for all public APIs. Documentation should:
Example:
/**
* Custom DNS lookup function.
* Defaults to dns.lookup.
* Used in Node.js (>= v12.x) environment only.
*/
lookupFunction?: LookupFunction;
/**
* Whether to enable endpoint discovery for operations that allow
* optionally using an endpoint returned by the service.
*/
endpointDiscovery?: boolean;
Thorough documentation helps other developers understand how to use your code correctly and identify potential limitations or requirements.
Enter the URL of a public GitHub repository