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

update docs #32

Merged
merged 7 commits into from
Dec 10, 2019
Merged

update docs #32

merged 7 commits into from
Dec 10, 2019

Conversation

aviatesk
Copy link
Contributor

@aviatesk aviatesk commented Dec 7, 2019

several updates:

  • update Documenter and fix docs (by adding MacroTools dependency)
  • use moer xcall API
  • fix typos
  • fix refs

@MikeInnes
Copy link
Member

Thanks for this. I think the functions which have docs should generally be added as exports; we should avoid having IRTools.Inner.* references in the docs, since things should either be exported and documented or neither.

@aviatesk
Copy link
Contributor Author

aviatesk commented Dec 10, 2019

thanks for the feedback :)

I think the functions which have docs should generally be added as exports; we should avoid having IRTools.Inner.* references in the docs, since things should either be exported and documented or neither.

Okay, I can follow your direction. So how about exporting them ?

I also found

  • Base.permute!
  • branch!
  • return!

are exported but not included as in the reference.

@MikeInnes
Copy link
Member

Thanks!

@MikeInnes MikeInnes merged commit 6bfef0a into FluxML:master Dec 10, 2019
@aviatesk aviatesk deleted the updatedocs branch December 10, 2019 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants