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

Initial implementation of documentation #52

Merged
merged 9 commits into from
Apr 27, 2022
Merged

Initial implementation of documentation #52

merged 9 commits into from
Apr 27, 2022

Conversation

eliascarv
Copy link
Member

@eliascarv eliascarv commented Apr 24, 2022

I was inspired by the Meshes.jl reference guide to make this reference guide. I think the sections could have better separation and better names.
I'm waiting for your suggestions @juliohm.
Edit:
I put the README text in index.md and added the Transforms docstrings in transforms.md.

@eliascarv eliascarv requested a review from juliohm April 24, 2022 13:33
@codecov-commenter
Copy link

codecov-commenter commented Apr 24, 2022

Codecov Report

Merging #52 (958d56b) into master (1c678e7) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #52   +/-   ##
=======================================
  Coverage   92.84%   92.84%           
=======================================
  Files          19       19           
  Lines         461      461           
=======================================
  Hits          428      428           
  Misses         33       33           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1c678e7...958d56b. Read the comment docs.

@eliascarv eliascarv marked this pull request as ready for review April 24, 2022 13:40
@eliascarv eliascarv changed the title WIP Reference guide Reference guide Apr 24, 2022
Copy link
Member

@juliohm juliohm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we have a preview of the docs in the PR? I remember it is possible to configure Documenter.jl and the repo to show a preview. Someone asked this recently on Zulip as well. Can you double check?

docs/src/traits.md Outdated Show resolved Hide resolved
docs/src/links.md Outdated Show resolved Hide resolved
@eliascarv eliascarv changed the title Reference guide Initial implementation of documentation Apr 24, 2022
@eliascarv eliascarv requested a review from juliohm April 24, 2022 21:03
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/transforms.md Outdated Show resolved Hide resolved
docs/src/transforms.md Outdated Show resolved Hide resolved
@eliascarv eliascarv requested a review from juliohm April 27, 2022 01:06
@eliascarv
Copy link
Member Author

I updated the examples of the apply and revert functions. @juliohm please take a look.

docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/transforms.md Outdated Show resolved Hide resolved
@eliascarv eliascarv requested a review from juliohm April 27, 2022 13:04
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/transforms.md Outdated Show resolved Hide resolved
@eliascarv eliascarv requested a review from juliohm April 27, 2022 17:11
Copy link
Member

@juliohm juliohm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work. 💯

@eliascarv
Copy link
Member Author

Thanks

@juliohm juliohm merged commit fe233cc into JuliaML:master Apr 27, 2022
@eliascarv eliascarv deleted the doc branch April 27, 2022 21:16
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.

None yet

3 participants