Skip to content

Wrong comments for function addNote #1634

@virgilwashere

Description

@virgilwashere

semantic-release/lib/git.js

Lines 321 to 327 in 9635f50

* Get and parse the JSON note of a given reference.
*
* @param {Object} note The object to save in the reference note.
* @param {String} ref The Git reference to add the note to.
* @param {Object} [execaOpts] Options to pass to `execa`.
*/
async function addNote(note, ref, execaOptions) {

The addNote function has the same description as getNote

Suggest

* Get and parse the JSON note of a given reference.

should be something like:

* Add JSON note to a given reference.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions