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

Improve docs for all the main functions #38

Open
sreecodeslayer opened this issue Aug 31, 2020 · 4 comments
Open

Improve docs for all the main functions #38

sreecodeslayer opened this issue Aug 31, 2020 · 4 comments
Labels
good-first-issue Good for newbies / that are still green ;)

Comments

@sreecodeslayer
Copy link

As of now, Hex docs are empty for the functions. Although docs and some of the example usage is already present in the README, it would be nice to have the same and more on the hexdocs.

@szymon-jez szymon-jez added the good-first-issue Good for newbies / that are still green ;) label Aug 31, 2020
@paulhenri
Copy link

Hi,
Is it still needed ? Right now we can see there is no real documentation on hexdox.pm but some is already in the code.
I'd like to help on this if it is still needed.

@szymon-jez
Copy link
Member

Yes, please go ahead.

@paulhenri
Copy link

Will do :) I may need some time to figure out what the code is doing but i'm on it.

@szymon-jez
Copy link
Member

Some things to start from:

Generating docs...
warning: documentation references function "ExPhoneNumber.parse/2" but it is hidden
  README.md

warning: documentation references file "LICENSE.md" but it does not exist
  README.md

View "html" docs at "doc/index.html"
warning: documentation references function "ExPhoneNumber.parse/2" but it is hidden
  README.md

warning: documentation references file "LICENSE.md" but it does not exist
  README.md

View "epub" docs at "doc/ExPhoneNumber.epub"

@szymon-jez szymon-jez mentioned this issue Mar 9, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good-first-issue Good for newbies / that are still green ;)
Projects
None yet
Development

No branches or pull requests

3 participants