search

zeam-vm / pelemay

Pelemay is a native compiler for Elixir, which generates SIMD instructions. It has a plan to generate for GPU code.
Apache License 2.0
186 stars 13 forks source link

Description of the top of the API Reference is incomplete #62

Closed zacky1972 closed 5 years ago

zacky1972 commented 5 years ago

Describe the bug Description in README.md includes sample code, though that of the top of the API Reference in HexDocs ( https://hexdocs.pm/pelemay/0.0.3/api-reference.html ) don't so.

To Reproduce None.

Expected behavior Description of the top of the API Reference should include sample code.

Screenshots None.

Desktop (please complete the following information):

Additional context It is necessary to ask details of the specification of ExDoc and HexDocs to someone who understand it enough to explain it to us.

supersimple commented 5 years ago

@zacky1972 The API reference is supposed to be an abbreviated version of each moduledoc. If you would prefer not to have the api-reference page generated, you can set the option api_reference: false in your doc configs.

You can see an example here: https://hexdocs.pm/jason/api-reference.html#content where the content has been abbreviated from: https://hexdocs.pm/jason/Jason.Encoder.html

zacky1972 commented 5 years ago

Thank you for your advices @supersimple !!!

I'll try it.