Standardize Location type

Open
#2 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
42/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

Start by locating every use of loc, commentLineNumber, and tag.lineNumber in the documentationjs schema, then read the linked unist Location and Position interfaces. The work is done when contextual line and column information consistently uses those interfaces throughout the schema.

Written by the indexing model from the issue text.

Description

Standardize all contextual information related to line numbers / columns.

Currently documentationjs uses a mix of conventions:

  • loc property
  • commentLineNumber
  • tag.lineNumber

Replace all of these with the unist Location and Position interfaces.

Dominant language
JavaScript
Stars
8
Forks
1
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from documentationjs/documentation-schema

All issues in documentationjs/documentation-schema

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.