Possibly outdated information in the `add` docs

Open
#609 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
css, tailwindcss
Domain
documentation

Research direction

Compare the note in the linked add documentation with the quoted 0.8.4 release-note behavior, then verify the current comment and class-literal syntax. Update the documentation so its guidance matches the current behavior, including the proposed dashed-class example only if appropriate; done means the outdated warning is resolved.

Written by the indexing model from the issue text.

Description

In the add docs it says

Note: Hyperscript supports hyphens in object property names, so you can write add { font-size: '2em' }. However, double hyphens (--) mark comments in hyperscript, so if you need to use them for [CSS Custom Properties][], use quotes -- add { '--big-font-size': '2em' }.

But in the 0.8.4 release notes it says:

Comments now require two dashes and a space, like so: -- , which enables double dashes in class literals like so: add .foo--bar

So I guess the note can be removed, right?
Happy to open a PR if that's the case

PS: I'm also happy to add a note on using class names with a dash in them, as is frequent with TailwindCSS utilities. (.{'foo-bar'})

Dominant language
JavaScript
Stars
3.8k
Forks
171
PR merge metrics
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 bigskysoftware/_hyperscript

All issues in bigskysoftware/_hyperscript

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.