Closed
Description
Hi, I've just published a new version of my crate and the generated documentation is including a lot of bullet points that have never been included before.
https://docs.rs/easy-ml/1.8.1/easy_ml/index.html
https://docs.rs/easy-ml/1.8.0/easy_ml/index.html
When I generate the docs locally on the 1.8.1 source code using the latest stable version of rust I see the same formatting for the 1.8.0 that docs.rs generated, so I think this is a bug that's slipped into the nightly version of docs.rs?
My guess is that it's because I'm using block comments, the unwanted bullet points seem to match up with empty lines in the documentation comment which consist of just a *
.
/*!
* If this is your first time using Easy ML you should check out some of the examples
* to get an overview of how to use matrices then study the
* [Matrix](matrices::Matrix) type for what you need.
*
* # Examples
* - [Linear Regression](linear_regression)
* - [k-means Clustering](k_means)
* - [Logistic Regression](logistic_regression)
* - [Naïve Bayes](naive_bayes)
* - [Neural Network XOR Problem](neural_networks)
*
* # API Modules
* - [Matrices](matrices)
* - [Linear Algebra](linear_algebra)
* - [Distributions](distributions)
* - [(Automatic) Differentiation](differentiation)
* - [Numerical type definitions](numeric)
*
* # Miscellaneous
* - [Web Assembly](web_assembly)
* - [SARSA and Q-learning using a Matrix for a grid world](sarsa)
* - [Using custom numeric types](using_custom_types)
*/
Thanks