less / less/less-docs

Document the additionalData argument

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

Nobody has claimed this yet.

Dominant language
Less
Stars
680
Forks
442
PR merge metrics
No merged PRs in 30d

Description

https://github.com/less/less.js/blob/master/lib/less/parser.js#L361

  • globalVars
  • modifyVars
  • banner

Are these things planning on staying this way, or are they not intended to be documented as they might change? I see that globalVars is documented with the browser version, but really it just sets one of these additionalData variables to be used in the parse method.

Contributor guide

Open the contributing guide

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.

Research direction

Start with lib/less/parser.js around line 361 and inspect how additionalData is used by the parse method. Compare this with the existing browser documentation for globalVars, then determine the intended documentation scope for globalVars, modifyVars, and banner. Done means the additionalData argument and these variables are documented with their supported status and usage.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.