Skip to content

docs: Fix incorrect return type in Parse.Object.getACL #2006

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

Merged
merged 2 commits into from
Aug 29, 2023

Conversation

dplewis
Copy link
Member

@dplewis dplewis commented Aug 29, 2023

Pull Request

Issue

Fixing getACL type to match PHP SDK getACL

Closes: #1949

I also ran into an issue testing npm run docs

FATAL: Unable to load template: Cannot find module 'taffydb'
Require stack:
- /Users/dplewis/Documents/GitHub/Parse-SDK-JS/node_modules/@parse/minami/publish.js
- /Users/dplewis/Documents/GitHub/Parse-SDK-JS/node_modules/jsdoc/cli.js
- /Users/dplewis/Documents/GitHub/Parse-SDK-JS/node_modules/jsdoc/jsdoc.js

Tasks

  • Add changes to documentation (guides, repository pages, code comments)

@dplewis dplewis requested a review from mtrezza August 29, 2023 17:48
@codecov
Copy link

codecov bot commented Aug 29, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (54cadf6) 100.00% compared to head (25242ef) 100.00%.

❗ Current head 25242ef differs from pull request most recent head 941683e. Consider uploading reports for the commit 941683e to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##             alpha     #2006   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           61        61           
  Lines         6122      6122           
  Branches      1493      1493           
=========================================
  Hits          6122      6122           
Files Changed Coverage Δ
src/ParseObject.js 100.00% <ø> (ø)

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

@parse-github-assistant
Copy link

Thanks for opening this pull request!

Copy link
Member

@mtrezza mtrezza left a comment

Choose a reason for hiding this comment

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

Looks good, could we add the TS notation for this as well - or would that balloon this PR?

@mtrezza mtrezza changed the title fix: Parse.Object.getACL return type documentation docs: Parse.Object.getACL return type documentation Aug 29, 2023
@mtrezza mtrezza changed the title docs: Parse.Object.getACL return type documentation docs: Incorrect return type in Parse.Object.getACL Aug 29, 2023
@mtrezza mtrezza changed the title docs: Incorrect return type in Parse.Object.getACL docs: Fix incorrect return type in Parse.Object.getACL Aug 29, 2023
@dplewis
Copy link
Member Author

dplewis commented Aug 29, 2023

It would balloon as you would have to do the entire file also this PR just focuses on JS Docs

@mtrezza
Copy link
Member

mtrezza commented Aug 29, 2023

I though that could be done on a per-method basis - alright then.

@mtrezza mtrezza merged commit f80d833 into parse-community:alpha Aug 29, 2023
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 4.2.0-alpha.7

@parseplatformorg parseplatformorg added the state:released-alpha Released as alpha version label Aug 29, 2023
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 4.3.0-beta.1

@parseplatformorg parseplatformorg added the state:released-beta Released as beta version label Sep 16, 2023
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 4.3.0-alpha.1

@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 4.3.0

@parseplatformorg parseplatformorg added the state:released Released as stable version label Nov 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
state:released Released as stable version state:released-alpha Released as alpha version state:released-beta Released as beta version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistent return type / value for Parse.Object.getACL()
3 participants