A comma can be added to the next "If not further configured deletes data in columns that were removed or had their type changed in the model."

Open
#809 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
html
Domain
documentation

Research direction

Start at the linked Method sync API reference and locate the description for the options.alter.drop parameter. Add the introductory comma to the sentence, then verify that the updated wording appears correctly in the website documentation.

Written by the indexing model from the issue text.

Description

Issue Description

I found a possibly grammar improvement for the description of one of the sync function's parameters: options.alter.drop
<--
Try to be as clear as possible. Don't assume that the maintainers will immediately understand the problem. Write your issue in a way that new contributors can also help (add links to helpful resources when applicable).
-->

What was unclear/insufficient/not covered in the documentation

The sentence is clear, no error found, just a suggestion.

If possible: Provide some suggestion on how we can enhance the docs

Add an introductory comma to the aforementioned text, to connect better the clauses:
"If not further configured*,* deletes data in columns that were removed or had their type changed in the model."

Additional context

<-- Add any other context or screenshots about the issue here. -->

Method sync

Dominant language
HTML
Stars
30
Forks
170
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from sequelize/website

All issues in sequelize/website

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.