Skip to content

Fix: Typos in API docs that is generated from Phoenix repo JSDOC #164

Description

@devvaannsh

We might need to fix the JSDOC in phoenix repo. But since this errors are visible in docs site, I'm mentioning them here.

  • CodeInspection fix object property name is wrong: In CodeInspection.js file JSDoc, the fix object documentation says to use replace property. The actual working property name is replaceText . This causes fix buttons to not appear when following the docs

Current (broken) docs:

errorObj.fix = {
    replace: "corrected text",  // doesn't work
    rangeOffset: { start: {Number}, end: {Number} }
};

What actually works:

errorObj.fix = {
    replaceText: "corrected text",  // works
    rangeOffset: { start: {Number}, end: {Number} }
};

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions