Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Latex + Item + DOI bug in documentation #247

Open
ybarsami opened this issue Sep 11, 2019 · 3 comments
Open

Latex + Item + DOI bug in documentation #247

ybarsami opened this issue Sep 11, 2019 · 3 comments
Labels
bug Something isn't working documentation help wanted Extra attention is needed priority:medium

Comments

@ybarsami
Copy link

Hi and thanks for the project. I am considering using it for research, and thus just began to read the documentation.

I found 3 small and easy-to-fix bugs in the page https://pisa.readthedocs.io/en/latest/compress_index.html

  • first bug: in the "Elias-Fano" item, the latex code is not rendered properly (neither in the html doc, nor in the .pdf document)

  • second bug: the "Simple8b" is apparently not at the right position in the itemize (it currently has the same status as "Usage" and "Compression Algorithms" whereas it should be a sub-item of "Compression Algorithms" --- in the .md file, it's written as "Simple8b
    --------" instead of "### Simple8b")

  • third bug: in the VarintGB reference, the DOI is not rendered as a link. I believe this is because it is written "DOI=..." instead of "DOI: ..." (missing a space, and "=" instead of ":" is only cosmetic)

@ybarsami ybarsami added the bug Something isn't working label Sep 11, 2019
@elshize
Copy link
Member

elshize commented Sep 11, 2019

Thanks for finding those! Would you maybe want to create a pull request with fixes? :)

@ybarsami
Copy link
Author

I don't know how to fix the latex rendering

(and also I never did a pull request)

@elshize
Copy link
Member

elshize commented Sep 11, 2019

That's okay, thanks for pointing these out anyway!

@elshize elshize added help wanted Extra attention is needed documentation labels Sep 12, 2019
JMMackenzie added a commit that referenced this issue Oct 15, 2019
2/3 fixes for  #247
amallia pushed a commit that referenced this issue Oct 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation help wanted Extra attention is needed priority:medium
Projects
None yet
Development

No branches or pull requests

2 participants