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.

Sign up for GitHub

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

Jump to bottom

Overhaul documentation #250

Merged
merged 15 commits into from
Nov 29, 2023
Merged

Overhaul documentation #250

merged 15 commits into from
Nov 29, 2023

Conversation

lgoettgens
Copy link
Collaborator

@lgoettgens lgoettgens commented Nov 20, 2023 •
edited
Loading

  • Split into one doc page per test

Structurize, fill with content etc.:

  • ambiguities
  • deps_compat
  • exports
  • persistent_tasks
  • piracies
  • project_extras
  • stale_deps
  • unbound_args
  • test_all

Preview at https://juliatesting.github.io/Aqua.jl/previews/PR250/

@codecov Codecov
Copy link

codecov bot commented Nov 20, 2023 •
edited
Loading

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (e9a4230) 75.33% compared to head (ed512d6) 75.20%.
Report is 1 commits behind head on master.

Files Patch % Lines
src/persistent_tasks.jl 85.71% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #250      +/-   ##
==========================================
- Coverage   75.33%   75.20%   -0.14%     
==========================================
  Files          11       11              
  Lines         750      750              
==========================================
- Hits          565      564       -1     
- Misses        185      186       +1
Flag Coverage Δ
unittests 75.20% <85.71%> (-0.14%) ⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lgoettgens lgoettgens changed the title Small docs adjustments Overhaul documentation Nov 20, 2023
@lgoettgens lgoettgens requested a review from fingolfin November 20, 2023 10:45
@lgoettgens lgoettgens force-pushed the lg/docs branch 2 times, most recently from ea22e3a to 877283b Compare November 24, 2023 16:54
hyrodium
hyrodium reviewed Nov 24, 2023
View reviewed changes
docs/src/persistent_tasks.md Outdated Show resolved Hide resolved
docs/src/ambiguities.md Outdated Show resolved Hide resolved
lgoettgens
lgoettgens commented Nov 26, 2023
View reviewed changes
docs/src/ambiguities.md Outdated Show resolved Hide resolved
hyrodium
hyrodium reviewed Nov 29, 2023
View reviewed changes
docs/src/unbound_args.md Outdated Show resolved Hide resolved
hyrodium
hyrodium reviewed Nov 29, 2023
View reviewed changes
docs/src/unbound_args.md Outdated Show resolved Hide resolved
hyrodium
hyrodium reviewed Nov 29, 2023
View reviewed changes
docs/src/unbound_args.md Outdated Show resolved Hide resolved
hyrodium
hyrodium reviewed Nov 29, 2023
View reviewed changes
docs/src/unbound_args.md Outdated Show resolved Hide resolved
@lgoettgens lgoettgens mentioned this pull request Nov 29, 2023
Merged
hyrodium
hyrodium approved these changes Nov 29, 2023
View reviewed changes
Copy link
Contributor

@hyrodium hyrodium left a comment

Choose a reason for hiding this comment

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

LGTM!

@lgoettgens lgoettgens enabled auto-merge (squash) November 29, 2023 13:13
@lgoettgens lgoettgens merged commit 28d29dc into master Nov 29, 2023
22 of 23 checks passed
@lgoettgens lgoettgens deleted the lg/docs branch November 29, 2023 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hyrodium hyrodium hyrodium approved these changes

@fingolfin fingolfin Awaiting requested review from fingolfin

Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lgoettgens @hyrodium