solidjs / solid-docs-legacy

OLD documentation for SolidJS and related packages, replaced by https://github.com/solidjs/solid-docs-next
https://www.solidjs.com/
MIT License
188 stars 151 forks source link

Mistype in documentation #193

Closed lishine closed 2 years ago

lishine commented 2 years ago

Describe the bug

missing a word

Your Example Website or App

.

Steps to Reproduce the Bug or Issue

1

Expected behavior

.

Screenshots or Videos

image

Platform

Linux

Additional context

No response

ghost commented 2 years ago

Hello, I'm interested in this issue. I see it is missing a word after "a" in the screenshot. What word would you want added?

lishine commented 2 years ago

Setup function / configuration function ? 😄 Maybe the best to do is to ask the one who wrote the sentence 😁

mpeg commented 2 years ago

The word should be constructor – this actually seems to be an issue with the MDX parser, maybe it's somehow executing it as code so it ends up being an Object (as in, the constructor of the MDXContent?)

Either way, an easy fix would be to add a space to the word within the backticks like ` constructor` which won't make a difference to the display of it, but will fix the issue

I went ahead and created a pull request #202 with that fix, but feel free to close it if you want to fix a better way of fix upstream somehow.

mpeg commented 2 years ago

Any other property names on backticks seem to make it either resolve them or crash (e.g. hasOwnProperty will throw and toString renders [object Undefined])

I suppose would be good to open an issue on the library doing the markdown parsing and reference this one

edemaine commented 2 years ago

Fixed by #194