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

Discrepancy between Tutorial and API docs for Actions #2776

Closed
varholak-peter opened this issue May 15, 2019 · 0 comments
Closed

Discrepancy between Tutorial and API docs for Actions #2776

varholak-peter opened this issue May 15, 2019 · 0 comments

Comments

@varholak-peter
Copy link
Contributor

Description

The Tutorial mentions that destroy function must be present in the object returned from an Action, however, the API docs label the return value of an Action as optional. (Or when an action does return an object the destroy property may be optional as well.)

I believe the preferred solution would be to remove the "must have" from the tutorial instead of enforcing the return value.

Quick links

Tutorial: https://svelte.dev/tutorial/actions
Docs: https://svelte.dev/docs#Actions

colincasey added a commit to colincasey/svelte that referenced this issue May 28, 2019
* master: (87 commits)
  -> v3.4.3
  always add raw property to text nodes
  flesh out in/out transition tutorial chapter (sveltejs#2792)
  code style
  fix test
  fix tests
  Fix CRUD example to allow changing input values.
  Fixes sveltejs#2714
  treat requestAnimationFrame as a noop on the server
  site: actions tutorial: destroy is not required (sveltejs#2776)
  Allow binding of <details> open
  site: add /faq redirect to GitHub wiki FAQ
  fix case sensitive import name, improve tsconfig
  type declarations for bundled files
  convert everything to TypeScript
  check for unknown props when creating component
  cleanup, improve comments
  typecheck npm script
  workarond for estree-walker related typings conflict
  compile/render-dom and other remaining typings
  ...

# Conflicts:
#	src/compile/render-dom/wrappers/Element/index.ts
colincasey added a commit to colincasey/svelte that referenced this issue May 28, 2019
…ings

* master: (66 commits)
  -> v3.4.3
  always add raw property to text nodes
  flesh out in/out transition tutorial chapter (sveltejs#2792)
  code style
  fix test
  fix tests
  Fix CRUD example to allow changing input values.
  Fixes sveltejs#2714
  treat requestAnimationFrame as a noop on the server
  site: actions tutorial: destroy is not required (sveltejs#2776)
  Allow binding of <details> open
  site: add /faq redirect to GitHub wiki FAQ
  fix case sensitive import name, improve tsconfig
  type declarations for bundled files
  convert everything to TypeScript
  check for unknown props when creating component
  cleanup, improve comments
  typecheck npm script
  workarond for estree-walker related typings conflict
  compile/render-dom and other remaining typings
  ...
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

No branches or pull requests

2 participants