woocommerce / woocommerce/code-reference

null and false don't show correctly in property signatures

Open
#19 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Twig
Stars
17
Forks
12
Avg merge
3h 58m
Merged PRs (30d)
3

Description

image


Here's an example:
https://woocommerce.github.io/code-reference/classes/WC-Data.html#property_meta_data

I did a bit of digging, and here are some lines you can see in the HTML files:
image

It seems like something is interpreting "false" as "\false" and is interpreting "null" as "\null".
https://www.php.net/manual/en/regexp.reference.escape.php

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.

Research direction

Reproduce the WC-Data property_meta_data example from the linked code reference and compare how null and false appear in the generated HTML. Trace the generator entry point that produces property signatures, then verify that the rendered signatures show the original values without unwanted escaping.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.