search

phibr0 / obsidian-dictionary

Dictionary - Obsidian Plugin | This plugin adds a multilingual dictionary to the Obsidian note taking tool.
GNU Affero General Public License v3.0
365 stars 45 forks source link

[Bug]: Documentation Error #84

Open mtuckerb opened 1 year ago

mtuckerb commented 1 year ago

Describe the bug

As a new user, I want the documentation for charts from md tables to be correct, so that I don't fumble around for ten minutes trying to figure it out.

AC#1 Given documentation regarding creating charts from markdown tables, when I copypasta the sample code, it will look like this Test1 Test2 Test3
Data1 1 2 3.33
Data2 3 2 1
Data3 6.7 4 2 ^table

Which seems to be the correct implementation.

Relevant errors (if available)

No response

Steps to reproduce

Consult the documentation here, and copy the table into a new obsidian doc. 

|       | Test1 | Test2 | Test3 |
| ----- | ----- | ----- | ----- |
| Data1 | 1     | 2     | 3.33  |
| Data2 | 3     | 2     | 1     |
| Data3 | 6.7   | 4     | 2     |
^table

and copy pasta the sample code for the chart and observe that the chart errors out. Then create a 5th column with the ^table reference in any or all of the cells. Notice that the chart renders.

Expected Behavior

The docs are correct.

Addition context

No response

Language

No response

API Name

No response

Operating system

macOS

mtuckerb commented 1 year ago

oh and the edit link for the page errors out too, which is why I opened the bug instead of fixing it my own darn self.