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 documentation #159

Merged
merged 6 commits into from
Jul 4, 2023
Merged

Update documentation #159

merged 6 commits into from
Jul 4, 2023

Conversation

lgoettgens
Copy link
Collaborator

Resolves #123.

I am happy to change anything, if requested.
If someone knows about a package following the best practices described here, I will gladly add it to the list.

@codecov
Copy link

codecov bot commented Jul 3, 2023

Codecov Report

Merging #159 (4ff4da3) into master (94a9c7a) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #159   +/-   ##
=======================================
  Coverage   77.07%   77.07%           
=======================================
  Files          11       11           
  Lines         724      724           
=======================================
  Hits          558      558           
  Misses        166      166           
Flag Coverage Δ
unittests 77.07% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/Aqua.jl 73.07% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@lgoettgens lgoettgens changed the title Update README.md Update documentation Jul 3, 2023
@lgoettgens
Copy link
Collaborator Author

I furthermore removed a compat info in a docstring for Aqua v0.5. In my opinion, this either belongs to release notes, or should be added similarly everywhere else. This lonely one doesn't make sense to me.

@lgoettgens
Copy link
Collaborator Author

Another slightly larger change: Much content of the README.md has been moved to the documentation. I didn't really like the previous hack to include the README.md as a docstring, and that lead to formatting issues. Now, the README.md is a lot shorter, as everything important has moved to the documentation.
In my opinion, the docs should be the one place where one can find everything.

Copy link
Collaborator

@fingolfin fingolfin left a comment

Choose a reason for hiding this comment

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

Looks good to me! Just to double check, did you verify that the resulting HTML produced by Documenter looks the way it should / you expect it to look?

README.md Outdated Show resolved Hide resolved
@lgoettgens
Copy link
Collaborator Author

Looks good to me! Just to double check, did you verify that the resulting HTML produced by Documenter looks the way it should / you expect it to look?

The doc preview unfortunately does not work since I work on a fork. But my local build looks good.

@fingolfin fingolfin merged commit 3f32ff2 into JuliaTesting:master Jul 4, 2023
@lgoettgens lgoettgens deleted the lg/readme branch July 5, 2023 06:19
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.

Improve docs: explain how to add Aqua to package tests
3 participants