Doc tests disabled?

[c-git]

Hi,

I was going through the code and noticed that doctest are disabled. I was curious if there was a reason.

umya-spreadsheet/Cargo.toml

Line 43 in 9b7e2bf

doctest = false

[c-git]

I guess I should also add why I care... I think one of the super powers of rust is tested docs. It improves users confidence in the docs because the code in there is usually tested and thus more reliable. That's why I was asking if there was a reason it was disabled.

[MathNya]

@c-git
Thank you.
I hadn't really paid much attention to this flag before.
So I'm not sure why it's set to false.
I'll change it to true.

[c-git]

There are currently a lot of failing doctests. Let me see how many I can correct. Should I add it to the same PR?

I'll add it to the same PR for now and I can split it later if you need me to.

[c-git]

Edit: Just realized that the key module is also not public so these docs will not show, so it's not actually a problem.

Old message

It seems there are some examples that aren't able to be run by users of the library because functions used in the examples are not public. For those where the documentation is attached to the function it's not a big problem because the documentation also will not show. However the following example would likely show but I can't see any way for the user to be able to run the example. Please let me know if there is a way for users to run the example that I missed please.

umya-spreadsheet/src/helper/crypt/key.rs

Lines 19 to 27 in 313a3de

	//! # Examples
	//!
	//! Generate an HMAC:
	//! ```
	//! use crate::crypto::hmac;
	//!
	//! let key = b"secret_key";
	//! let data = [b"data1", b"data2"];
	//! let mac = hmac(key, &data);

NB: The hmac function is not pub only pub(crate)

umya-spreadsheet/src/helper/crypt/key.rs

Line 78 in 313a3de

pub(crate) fn hmac(key: &[u8], buffers: &[&[u8]]) -> Vec<u8> {

[c-git]

I'll mark the code with TODOs where I find problems instead of putting multiple comments here as I find problems that will actually show.

[MathNya]

@c-git
Thank you for everything.
hmac is part of a set of functions designed to compress files; it is not intended to be provided to users on its own.
In other words, it is a private function.

[c-git]

Ok great then it's fine as is. I disabled the doctest for it because the doctest run as a separate create thus cannot use private functions.