-
-
Notifications
You must be signed in to change notification settings - Fork 606
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
fix IndexedDBStore API documentation #3987
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
um it looks like the changelog diff broke just now when I used the github edit feature - is there inconsistent line endings in the file causing the web editor diff to break? |
possibly. Not sure, I'm afraid |
I just removed the changelog entry now, seems to be too much of a hassle to get the line endings right with git (also there doesn't seem to be a "unreleased" version where I would need to put the new entry for the upcoming version) |
Wasn't the whole point of this PR to update the changelog?
Take a look at the contributing doc. The changelog is autogenerated. |
ah you are right sorry, I forgot what I actually did in this PR - I readded the changelog entry to the version where I put it earlier in the PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! A couple of final things, I'm afraid.
- It's failing CI due to a failure from the linter. It's probably complaining about line length, though I haven't checked in detail. Please either see what the matter with it is or run the changes through
prettier
. - We require sign-off for all changes, even ones as simple as this. Sorry! Please take a look at https://github.com/element-hq/element-web/blob/develop/CONTRIBUTING.md#sign-off and if you are happy, add a "Signed-off-by" line to the PR description.
ok should be good now |
Sorry, but as the contributing guide says, I'm afraid we don't accept contributions signed off under a pseudonym, so we'll need your real name to be able to accept this. See https://github.com/element-hq/element-web/blob/develop/CONTRIBUTING.md#private-sign-off. |
changes the changelog entry to include since when this change is needed fix matrix-org#3986 Signed-off-by: Jan Jurzitza <[email protected]>
Signed-off-by: Jan Jurzitza <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your patience!
Retroactively changes the changelog entry to include since when this change is needed as well, so that other people upgrading the SDK can more easily find what to change.
Fix #3986
Only documentation & error strings have changed so I have not adjusted any tests. A proper integration test would probably be nice, but I didn't have the time to look into how that is setup on this project.
This change is marked as an internal change (Task), so will not be included in the changelog.