Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable links in attributes's descriptions #40

Open
rgosse opened this issue Mar 28, 2022 · 0 comments
Open

Enable links in attributes's descriptions #40

rgosse opened this issue Mar 28, 2022 · 0 comments
Labels
enhancement New feature or request ⚡ good first issue Good for newcomers 🐎 priority

Comments

@rgosse
Copy link
Collaborator

rgosse commented Mar 28, 2022

Adding a @link within an attribute description currently throws:

Error: The TSDocConfiguration does not allow a EmphasisSpan node to contain a node of type LinkTag

It prevents from writing things like:

/**
 * Indices allowing to retrieve a cell in a cellSet.
 */
export interface CellIndices {
  rowIndex: number;
  columnIndex: number;
  /**
   * @deprecated use `rowIndex` and `columnIndex` to retrieve a {@link Cell} from the chart metadata's `cellMatrix`.
   */
  cellIndex: number;
}
@Nouzbe Nouzbe added the enhancement New feature or request label Feb 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ⚡ good first issue Good for newcomers 🐎 priority
Projects
None yet
Development

No branches or pull requests

3 participants