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

Rename Client Config to Account Data #2032

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

yoyodragon
Copy link

@yoyodragon yoyodragon commented Dec 14, 2024

Part of issue #2030.

Pull Request Checklist

Preview: https://pr2032--matrix-spec-previews.netlify.app

@yoyodragon yoyodragon requested a review from a team as a code owner December 14, 2024 20:54
Copy link
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

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

I assume this is related to #2030.

Thank you for the contribution. It's a fair start, but - even though I said "don't try to solve everything at once" - I think this is the opposite extreme. Just changing the list of modules, without actually changing the name of the section itself, is going to cause confusion. Perhaps you could update your PR so that you're also changing the name of the section itself.

A couple of other points to note:

  • It's helpful to give a bit of description in the PR title about what the PR is trying to achieve. "Update _index.md" doesn't really tell anyone anything.
  • You've ticked "Pull request includes a sign off", but your pull request does not, in fact, include a sign off.

Signed-off-by: Ved Prasad Bankeshwar [email protected]
@yoyodragon yoyodragon changed the title Update _index.md Update _index.md change Client Config to Account Data Dec 15, 2024
@yoyodragon yoyodragon changed the title Update _index.md change Client Config to Account Data Update _index.md change Client Config to Account Data issue #2030 Dec 15, 2024
@yoyodragon
Copy link
Author

Thank you for the suggestions, I have tried implementing them to the best of my knowledge.
I am new to open source and am not completely aware of the rules and protocols followed, I'm sorry for the inconvenience.Please let me know if I have to make a changelog entry too, I couldn't figure out where to do it.
Thank you.

Copy link
Contributor

@zecakeh zecakeh left a comment

Choose a reason for hiding this comment

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

Please let me know if I have to make a changelog entry too, I couldn't figure out where to do it.

Yes, every PR must have a changelog entry. Are the instructions not clear in CONTRIBUTING.rst?

Also this qualifies as "other changes" as far as I can tell.

@@ -557,7 +557,7 @@ Since the draft stage, the following major changes have been made:
- Invites based on third-party identifiers
- Room tagging
- Guest access
- Client config
- Account Data
Copy link
Contributor

Choose a reason for hiding this comment

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

You should not edit an old changelog entry.

@@ -15,7 +15,7 @@
# limitations under the License.
openapi: 3.1.0
info:
title: Matrix Client-Server Client Config API
title: Matrix Client-Server Account Data API
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this is quite right (but it was already wrong before). Looking at the spec it looks like it should be "Key Management API" for this file.

@@ -2927,7 +2927,7 @@ that profile.
| [Typing Notifications](#typing-notifications) | Required | Required | Required | Required | Optional |
| [User and Room Mentions](#user-and-room-mentions) | Required | Required | Required | Optional | Optional |
| [Voice over IP](#voice-over-ip) | Required | Required | Required | Optional | Optional |
| [Client Config](#client-config) | Optional | Optional | Optional | Optional | Optional |
| [Account Data](#client-config) | Optional | Optional | Optional | Optional | Optional |
Copy link
Contributor

Choose a reason for hiding this comment

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

You also need to apply changes to the URL fragment. #client-config should have been changed to #account-data, here and maybe in other parts of the spec.

@richvdh richvdh changed the title Update _index.md change Client Config to Account Data issue #2030 Rename Client Config to Account Data Dec 15, 2024
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

Successfully merging this pull request may close these issues.

3 participants