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

Update the description for the complex-numbers exercise #2496

Merged
merged 18 commits into from
Nov 20, 2024

Conversation

jagdish-15
Copy link
Contributor

@jagdish-15 jagdish-15 commented Nov 12, 2024

Pull Request Description

This pull request updates the description file for the Complex Number exercise, as discussed in the forum thread. The changes reflect the updated description with no objections raised during the discussion.

@jagdish-15 jagdish-15 requested a review from a team as a code owner November 12, 2024 14:43
Copy link
Contributor

Hello. Thanks for opening a PR on Exercism 🙂

We ask that all changes to Exercism are discussed on our Community Forum before being opened on GitHub. To enforce this, we automatically close all PRs that are submitted. That doesn't mean your PR is rejected but that we want the initial discussion about it to happen on our forum where a wide range of key contributors across the Exercism ecosystem can weigh in.

You can use this link to copy this into a new topic on the forum. If we decide the PR is appropriate, we'll reopen it and continue with it, so please don't delete your local branch.

If you're interested in learning more about this auto-responder, please read this blog post.


Note: If this PR has been pre-approved, please link back to this PR on the forum thread and a maintainer or staff member will reopen it.

@github-actions github-actions bot closed this Nov 12, 2024
@Cool-Katt Cool-Katt reopened this Nov 12, 2024
@Cool-Katt
Copy link
Contributor

@jagdish-15 Looks like you might have forgotten to run the linter on this.

@tasxatzial tasxatzial changed the title Updating description.md Update the description for the complex-numbers exercise Nov 12, 2024
@jagdish-15
Copy link
Contributor Author

@Cool-Katt, apologies for the initial oversight!

I’ve updated the file so it now passes all tests. I’m a bit uncertain about the ordered list formatting—I've prefixed each item with “1.” as required by markdownlint, but if there’s a better approach, I'd appreciate any guidance. Thanks!

@tasxatzial

This comment was marked as outdated.

Copy link
Member

@SleeplessByte SleeplessByte left a comment

Choose a reason for hiding this comment

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

For those who want to see the rich text in the latest form when reviewing. And here is the split raw view without whitespace changes

exercises/complex-numbers/description.md Outdated Show resolved Hide resolved
Copy link
Member

@SleeplessByte SleeplessByte left a comment

Choose a reason for hiding this comment

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

Tentatively approved if you fix the linter.

I think this is better than what it was, so yah.

@jagdish-15
Copy link
Contributor Author

Thank you so much for the feedback, @SleeplessByte! I'll definitely address the linter issues. If you notice any other areas for improvement or have any suggestions for refining this version further, I’d love to hear them!

@jagdish-15
Copy link
Contributor Author

I’d also love to know if this change will automatically update in instructions.md across all tracks, or if it’ll require a manual update.

@BNAndras
Copy link
Member

I’d also love to know if this change will automatically update in instructions.md across all tracks, or if it’ll require a manual update.

Each track will need to sync it manually. Some tracks do have tooling to alert the maintainer when there are unsynced changes in the problem specifications repo, but the actual syncing is still done by a human.

@tasxatzial
Copy link
Member

It is possible to trigger a PR that updates the description across all tracks with a script. However, it's more likely that track maintainers will perform a batch sync once a month, for example, to pull in all changes from this repo.

@jagdish-15
Copy link
Contributor Author

Thank you so much, everyone!

Before wrapping up, I’d love to know if there’s anything I should keep in mind for next time, or if you’d like any additional changes to the current file.

Copy link
Member

@tasxatzial tasxatzial left a comment

Choose a reason for hiding this comment

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

One small change for consistency

exercises/complex-numbers/description.md Outdated Show resolved Hide resolved
Copy link
Member

@tasxatzial tasxatzial left a comment

Choose a reason for hiding this comment

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

One more, sorry for the multiple comments. This is recommended by the AP style and Chicago manual of style

exercises/complex-numbers/description.md Outdated Show resolved Hide resolved
@jagdish-15
Copy link
Contributor Author

Thank you so much, @tasxatzial! I really appreciate all your help. If there’s anything else that might need fixing, I’d love to hear your suggestions.

Copy link
Member

@tasxatzial tasxatzial left a comment

Choose a reason for hiding this comment

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

Hopefully the final suggestion. I just realized that the "exponent of a complex" number isn't even proper math. Let's fix that.

exercises/complex-numbers/description.md Outdated Show resolved Hide resolved
@jagdish-15
Copy link
Contributor Author

jagdish-15 commented Nov 12, 2024

It's done, @tasxatzial!

@SleeplessByte
Copy link
Member

Now we just need @exercism/maintainers-admin to sign-off. Great work @jagdish-15.

Copy link
Member

@tasxatzial tasxatzial left a comment

Choose a reason for hiding this comment

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

@jagdish-15 Final suggestion, this is also for consistency with the previous part that introduces exponentiation

exercises/complex-numbers/description.md Outdated Show resolved Hide resolved
exercises/complex-numbers/description.md Outdated Show resolved Hide resolved
exercises/complex-numbers/description.md Outdated Show resolved Hide resolved
@jagdish-15
Copy link
Contributor Author

jagdish-15 commented Nov 17, 2024

I believe this addresses both of the issues mentioned above. @tasxatzial, @ErikSchierboom, @IsaacG, @SleeplessByte, @Cool-Katt, and @BNAndras—please let me know if there’s anything else that needs attention.

[I've done two more commits after this]

@jagdish-15
Copy link
Contributor Author

I've updated the description and made several changes to improve clarity and formatting. Could you please review it and let me know if any further adjustments are needed?

exercises/complex-numbers/description.md Outdated Show resolved Hide resolved
Copy link
Member

@tasxatzial tasxatzial left a comment

Choose a reason for hiding this comment

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

Looks great.

@jagdish-15 Thanks for your incredible patience and effort!

@jagdish-15
Copy link
Contributor Author

With this commit, I believe the formatting issues are resolved, and this should be ready to merge. Please let me know if I’ve missed anything.

A big thank you to @ErikSchierboom, @kotp, @Cool-Katt, @BNAndras, and @SleeplessByte, and especially to @tasxatzial and @IsaacG for reviewing this and providing your valuable feedback!

Copy link
Member

@IsaacG IsaacG 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 to me!

@ErikSchierboom ErikSchierboom merged commit b5e9272 into exercism:main Nov 20, 2024
7 checks passed
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.

8 participants