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

[JOSS Review] Formatting issues in documentation #361

Closed
mlgill opened this issue Apr 8, 2018 · 4 comments
Closed

[JOSS Review] Formatting issues in documentation #361

mlgill opened this issue Apr 8, 2018 · 4 comments

Comments

@mlgill
Copy link

mlgill commented Apr 8, 2018

The examples section for bootstrap_point632_score appears to have formatting issues, here

@mlgill mlgill changed the title [JOSS Review] Formatting issues for bootstrap_point632_score examples in documentation [JOSS Review] Formatting issues in documentation Apr 8, 2018
@mlgill
Copy link
Author

mlgill commented Apr 8, 2018

Is is possible to improve the formatting for equations listed for metrics in association_rules?

@mlgill
Copy link
Author

mlgill commented Apr 8, 2018

The examples section for counter appears to have formatting issues here.

@rasbt
Copy link
Owner

rasbt commented Apr 9, 2018

Thanks for pointing that out. The documentation is auto-generated, and I'll check if there's something that can be done about that via the parser. I also think the example sections are a bit redundant -- mainly left-overs from back when there were no other examples in the docs.

@rasbt
Copy link
Owner

rasbt commented Apr 11, 2018

All the things you highlighted should be fixed now! I am actually never using the API docs as a reference myself but usually click on the respective user guide page and scroll down to the API section there ...
Anyways, I just saw that the entries in the API docs were also not in alphabetical order and changed that to make it easier to navigate.

@rasbt rasbt closed this as completed Apr 11, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants