search

Gmousse / dataframe-js

No Maintenance Intended
https://gmousse.gitbooks.io/dataframe-js/
MIT License
460 stars 38 forks source link

[BUG] Minor documentation issues for API references #104

Closed dhorvay closed 4 years ago

dhorvay commented 4 years ago

Describe the bug The API references in documentation are pointing to wrong hyperlink, which results in error to see exact lines of code that is referred.

To Reproduce Steps to reproduce the behavior:

  1. Go to https://gmousse.gitbooks.io/dataframe-js/content/doc/api/dataframe.html#dataframe
  2. Click on src/dataframe.js:11-1243
  3. See error e.g. error: "Not Found" (Firefox)

Expected behavior I expect that the link will go directly to the line of code being referred

Screenshots

Screen Shot 2020-04-05 at 11 00 28 PM

Desktop:

Additional context Issue is unneeded colon.

dhorvay commented 4 years ago

Easy fix. Will make PR when #101 is closed.

Gmousse commented 4 years ago

Thank you @dhorvay ! Your PR is welcome (#101 is closed on develop and will be released on a hotfix 1.4.4).

Gmousse commented 4 years ago

@dhorvay The error seems related to the library used to build the documentation https://github.com/documentationjs/documentation/issues/1295

I will update it and publish it on the hotfix 1.4.4 (no need of a PR here)

Thanks !