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(image): add content warnings to image function jsdocs #2159

Merged
merged 4 commits into from
May 25, 2023

Conversation

ejcheng
Copy link
Member

@ejcheng ejcheng commented May 14, 2023

closes #1783

Adds disturbing image warnings to jsdocs for each function in the image module

@ST-DDT Should I also add something about usage limits? #1783 (comment)

@ejcheng ejcheng added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent m: image Something is referring to the image module labels May 14, 2023
@ejcheng ejcheng requested a review from a team May 14, 2023 16:34
@ejcheng ejcheng self-assigned this May 14, 2023
@ejcheng ejcheng requested a review from a team as a code owner May 14, 2023 16:34
@codecov
Copy link

codecov bot commented May 14, 2023

Codecov Report

Merging #2159 (278751d) into next (c173150) will decrease coverage by 0.01%.
The diff coverage is 100.00%.

❗ Current head 278751d differs from pull request most recent head 43eeeb4. Consider uploading reports for the commit 43eeeb4 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #2159      +/-   ##
==========================================
- Coverage   99.60%   99.59%   -0.01%     
==========================================
  Files        2607     2607              
  Lines      244977   245013      +36     
  Branches     1151     1150       -1     
==========================================
+ Hits       244010   244032      +22     
- Misses        940      954      +14     
  Partials       27       27              
Impacted Files Coverage Δ
src/modules/image/providers/lorempicsum.ts 92.30% <100.00%> (+0.58%) ⬆️
src/modules/image/providers/placeholder.ts 100.00% <100.00%> (ø)
src/modules/image/providers/unsplash.ts 100.00% <100.00%> (ø)

... and 6 files with indirect coverage changes

@xDivisionByZerox
Copy link
Member

@ST-DDT Should I also add something about usage limits? #1783 (comment)

I'm not him, but yes I think you should. You cross reference #1783 which describes both doc changes (warning and limit usage).

@ejcheng ejcheng requested a review from matthewmayer May 18, 2023 04:14
@ST-DDT ST-DDT enabled auto-merge (squash) May 25, 2023 22:58
@ST-DDT ST-DDT merged commit 012ba2c into next May 25, 2023
@ST-DDT ST-DDT deleted the docs/image_function_warnings branch May 25, 2023 23:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation m: image Something is referring to the image module p: 1-normal Nothing urgent
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add warning to image generator functions
4 participants