docs: Review documentation for "in-place" / "overlapping" operations.

[duesee]

Some functions are allowed to be called with overlapping memory but the documentation does not always specify that. Example: Ed25519::secret_to_public.

[ma-ilsi]

Some functions are allowed to be called with overlapping memory ... Example: Ed25519::secret_to_public.

I just looked at line 25 of the hacl-star source and I think public_key and private_key should not overlap.

Did you mean:

Some functions are not allowed to be called with overlapping memory

Would it also be helpful to slightly improve the documenting comments so the the Params and Returns headings can render when they are converted to docs?
As an example compare the aesthetic look EdDSA against the organized RSAPSS:

[franziskuskiefer]

Would it also be helpful to slightly improve the documenting comments so the the Params and Returns headings can render when they are converted to docs?

Yeah I agree. The RSA docs are way nicer to read. Organising them would be great.
Again, this needs to be done on the hacl-star side.

[ma-ilsi]

Okay great. Thanks for the green light 🚦.