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

initialize documentation #27

Merged
merged 2 commits into from
Oct 20, 2021
Merged

initialize documentation #27

merged 2 commits into from
Oct 20, 2021

Conversation

johnnychen94
Copy link
Member

@johnnychen94 johnnychen94 commented Oct 19, 2021

Although we'll eventually move all packages to Images.jl as a monorepo JuliaImages/Images.jl#898, it still makes sense to set up the documentation at the moment.

I deliberately not add ImageBase.IfElse to the function reference page, because I think it's more of an internal implementation trick.

@codecov
Copy link

codecov bot commented Oct 19, 2021

Codecov Report

Merging #27 (788c87d) into master (5687005) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #27   +/-   ##
=======================================
  Coverage   92.07%   92.07%           
=======================================
  Files           5        5           
  Lines         227      227           
=======================================
  Hits          209      209           
  Misses         18       18           
Impacted Files Coverage Δ
src/diff.jl 96.55% <ø> (ø)

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 5687005...788c87d. Read the comment docs.


This package can be seen as an experimental package inside JuliaImages:

1. functions here might be moved to a seperate package if they get better supports (with more dependency), and
Copy link
Member

Choose a reason for hiding this comment

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

I see name ImageBase as conveying "algorithms I wish I had access to in other low-level packages" and not "a dumping ground for stuff that I don't know where else to put it." Images.jl is probably better suited for the latter.

Copy link
Member Author

Choose a reason for hiding this comment

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

Months ago when I started this package I'm not very sure of this and it was only restrict at that time. I guess I can just remove these explanations now.

@johnnychen94 johnnychen94 merged commit 8ec212b into master Oct 20, 2021
@johnnychen94 johnnychen94 deleted the jc/docs branch October 20, 2021 14:41
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