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

docs: add missing pages for certain functions #102

Merged
merged 21 commits into from
Mar 1, 2024

Conversation

EscapedGibbon
Copy link
Contributor

No description provided.

@EscapedGibbon EscapedGibbon linked an issue Feb 15, 2024 that may be closed by this pull request
Copy link

cloudflare-workers-and-pages bot commented Feb 15, 2024

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4c65b35
Status: ✅  Deploy successful!
Preview URL: https://a66c4c41.image-js-docs.pages.dev
Branch Preview URL: https://100-add-missing-pages-for-ce.image-js-docs.pages.dev

View logs

@EscapedGibbon EscapedGibbon marked this pull request as ready for review February 19, 2024 09:37
@EscapedGibbon EscapedGibbon force-pushed the 100-add-missing-pages-for-certain-functions branch from 90a3a34 to 635a972 Compare February 19, 2024 09:39
EscapedGibbon and others added 7 commits February 28, 2024 21:30
…#89)

* docs wip write roi analysis page

* docs wip add some code for analysis

* docs wip add images and

* docs wip add images of metadata

* docs wip add code examples

* docs: add quotes to some tags mentions

* add: extra data images and roi properties table

* docs: replace an image with comparison

* docs: fix spelling check

* docs: improve text and fix minor errors

* docs: create metadata tutorial and add more code to roi tutorial

* docs wip rework roi analysis page

* docs: move distribution graph

* docs: fix case sensitivity error

* docs: fix the unit in pixel size

* docs wip change roundness part of the tutorial

* docs wip add screws image analysis

* docs: add explanations to irregular behavior of some ROIs and add images

* docs wip explain how to sort nuts from washers

* docs: add final result and remove unused images

* docs: add minor changes and fix minor errors

* docs: add more details to metadata intro

* docs: make minor changes

* docs: redo size distribution example and fix screws example

* docs: improve phrasing in metadata tutorial

* docs: minor fixes in code examples

* docs: resolve conversations

* docs: restructure mbr graph

* docs: add XML mention to extra data

* docs: update machine learning classifier link
* docs: fix minor issues in basics section

* docs: fix minor issues in filters section

* docs: fix minor issues in comparison section

* docs: fix minor issues in geometry section

* docs: minor fixes in morphology section

* docs: minor fixes in operations section

* docs: minor fixes in roi analysis section

* docs: minor fixes in tips section

* docs: minor fixes in tutorials section

close: #81

* docs: remove invalid link

* docs: fix prettier error
@stropitek
Copy link
Contributor

CleanShot 2024-03-01 at 14 27 30

Do not add meta-code comments. Stick with just commenting stuff that has a link to image-js.

CleanShot 2024-03-01 at 14 29 19

Is "opaque blakc" actually the default value?

@EscapedGibbon
Copy link
Contributor Author

CleanShot 2024-03-01 at 14 27 30

Do not add meta-code comments. Stick with just commenting stuff that has a link to image-js.

CleanShot 2024-03-01 at 14 29 19

Is "opaque blakc" actually the default value?

Kind of. If color is not specified then ,by default, it calls getDefaultColor function which in turn will give a black color array. The length of array depends on the color model. It is also indicated like that in the typedoc.

CleanShot 2024-03-01 at 15 20 36

@stropitek
Copy link
Contributor

stropitek commented Mar 1, 2024

The quotes in the default value are misleading as they imply that you can pass the "Opaque black" string to the option. Also isn't "opaque black" the same as just "black"? If it is not transparent at all then just "black" doesn't introduce an ambiguity on the level of opacity.

@stropitek stropitek merged commit 5bca291 into main Mar 1, 2024
7 checks passed
@stropitek stropitek deleted the 100-add-missing-pages-for-certain-functions branch March 1, 2024 16:37
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.

add missing pages for certain functions
2 participants