-
Notifications
You must be signed in to change notification settings - Fork 46
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
Big docs & readme update #98
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't check every single line but it looks good to me, I also agree some of the contents here are redundant. I kept some of the old contents during the transition because I didn't think of a good replacement for them. As a non-native English speaker, I enjoy @Evizero's words a lot.
0f98eec
to
ddea709
Compare
Yeah, the sentences read nicely. For example, the part about images in Julia was quite educational. I almost felt pity removing it. On the other hand, maintaining the documentation is perhaps harder than maintaining the code, so I aimed to cut down anything that is not necessary (in this specific case, the documentation is available elsewhere -- JuliaImages docs). Also, I think having less text is better for the users as it's easier to skim through. Edit: Let's keep this PR open for a while so @Evizero has a chance to express his opinion. |
Thanks for the kind words. While it was fun writing the images tutorial page, I do think it became outdated quite a while ago. I defer to your combined judgement which has been excellent so far. Thank you for your hard work |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very well written! The "Label-preserving Transformations" part is very educational; I believe most people are just ignorant about this.
I reckon that we should emphasize the importance of Colorant
array. Many issues in using this package are due to the old habit of the plain Array{Float64, 3}
data. I didn't comment on the "Complete example" section so you might need to update it as well.
Co-authored-by: Johnny Chen <johnnychen94@hotmail.com>
Co-authored-by: Johnny Chen <johnnychen94@hotmail.com>
Co-authored-by: Johnny Chen <johnnychen94@hotmail.com>
Co-authored-by: Johnny Chen <johnnychen94@hotmail.com>
Co-authored-by: Johnny Chen <johnnychen94@hotmail.com>
Co-authored-by: Johnny Chen <johnnychen94@hotmail.com>
Co-authored-by: Johnny Chen <johnnychen94@hotmail.com>
Co-authored-by: Johnny Chen <johnnychen94@hotmail.com>
Co-authored-by: Johnny Chen <johnnychen94@hotmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@barucden Unless requested, I don't have more comments in. With some final word tweaks, I think we're good to go. It's up to you.
Co-authored-by: Johnny Chen <johnnychen94@hotmail.com>
Co-authored-by: Johnny Chen <johnnychen94@hotmail.com>
Thanks for the feedback! I am merging it in now. We can continue to improve the documentation iteratively. |
# --- | ||
# title: Higher-order functions | ||
# description: a set of helper opeartions that allow applying any function | ||
# --- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like we need a cover image here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it required? I could not think of any since the operations are really general.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, but I guess it somehow doesn't look very nice if using the fallback cover... I really have a bad taste in designing the icon/cover. :(
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will try to add a better cover picture in near future
Okay, this one's a little bigger.
The goal is to simplify the docs: to contain only what's this package about so we can keep it up-to-date, no duplicates (rather use cross-references), simpler structure, less talking.
The biggest change in README is the addition of contributing section.
Main changes in docs:
MapFun
andAggregateThenMapFun
indices.md
I plan to do a few more smaller changes in the future (like adding more examples, simplify further, etc.)