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

complex-numbers concept docs #3554

Merged
merged 42 commits into from
Dec 5, 2023
Merged

Conversation

colinleach
Copy link
Contributor

New concept documents, for discussion.

You may want to cut the last bit of about.md. It got a bit preachy.

@colinleach
Copy link
Contributor Author

Should I have added a comment that only documentation changed? I don't want Exercism to re-run every submitted Python exercise!

@colinleach
Copy link
Contributor Author

Looking again at your Mermaid chart, I see that cmath has its own topic. My instinct is that this is a bit thin to break out by itself, but I'll be interested in your thoughts after reading this PR.

@BethanyG
Copy link
Member

New concept documents, for discussion.
You may want to cut the last bit of about.md. It got a bit preachy.

Ha! I often "preach", so might not notice. 😉 I am just now getting to things, so I will make sure to take a look and comment.

Looking again at your Mermaid chart, I see that cmath has its own topic. My instinct is that this is a bit thin to break out by itself, but I'll be interested in your thoughts after reading this PR.

Ha, yes! I completely agree. Brain fart on my part, since clearly the concept for complex numbers should include the mathematical operations that can be performed. Let's combine the two into this concept/exercise. I'll loop back and prettify the chart .... er .... later. 😉 (The thing is a tad involved to edit).

Should I have added a comment that only documentation changed? I don't want Exercism to re-run every submitted Python exercise!

You shouldn't have to do that for documentation, since its not considered "significant" for the re-queueing of solutions for test. And overall, you'll not be needing it for new exercises in general, because they won't have any existing solutions to test or re-test. Finally, I will add it in if needed during review. I got your back! 😄

@colinleach
Copy link
Contributor Author

I got your back!

Fortunate! I'll try not to call in this offer too frequently, but....

Copy link
Member

@BethanyG BethanyG left a comment

Choose a reason for hiding this comment

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

Nice work, you! I think this is a good start for the most part, but it might need a bit of re-arranging to present the practical parts of things in order.

I like all the references to application, but feel like a student would be searching for a few practical examples, but I am not clear yet on what they'd be that wouldn't have terrifying maths. My first impulse is an image translation, but .... not sure. Or maybe a simple circuit? Or a fractal? humm. I am going to let it sit a bit and then return tomorrow for another pass.

I am going to leave the introduction.md alone for now -- it needs to be shorter, but I can't think my way to it at the moment. Maybe after we both do a second pass.

concepts/complex-numbers/about.md Show resolved Hide resolved
concepts/complex-numbers/about.md Outdated Show resolved Hide resolved
concepts/complex-numbers/about.md Show resolved Hide resolved
concepts/complex-numbers/about.md Outdated Show resolved Hide resolved
concepts/complex-numbers/about.md Outdated Show resolved Hide resolved
concepts/complex-numbers/about.md Outdated Show resolved Hide resolved
concepts/complex-numbers/about.md Outdated Show resolved Hide resolved
concepts/complex-numbers/about.md Outdated Show resolved Hide resolved
concepts/complex-numbers/about.md Outdated Show resolved Hide resolved
concepts/complex-numbers/about.md Outdated Show resolved Hide resolved
colinleach and others added 24 commits November 27, 2023 07:52
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Copy link
Member

@BethanyG BethanyG left a comment

Choose a reason for hiding this comment

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

Nice work on re-writing! 🚀

I am highly tempted to say we are done with this until we can figure out some longer examples and the pending questions about the complex plane, the unit circle, and ... what the heck we think we're going to cook up as an exercise.

I am almost to "let's merge this down, and come back later" - my only worry is that if we do that, it will show on the site (albeit not very discoverable) - so there might be critique from anyone who reads it. Then again, it would tell us if we've hit or missed the mark. What are your thoughts?

If you agree, I can put together an intro.md, and then we can both re-read the docs and merge.

concepts/complex-numbers/about.md Outdated Show resolved Hide resolved
concepts/complex-numbers/about.md Outdated Show resolved Hide resolved
concepts/complex-numbers/about.md Outdated Show resolved Hide resolved
concepts/complex-numbers/about.md Outdated Show resolved Hide resolved
concepts/complex-numbers/about.md Outdated Show resolved Hide resolved
concepts/complex-numbers/about.md Outdated Show resolved Hide resolved
concepts/complex-numbers/about.md Outdated Show resolved Hide resolved
Less obviously, sound is wave-like, light is wave-like, radio signals are wave-like, The economy of your home country is at least partly wave-like.

A lot of this can be done with trig functions (`sin()` and `cos()`) but that gets messy quickly.
Complex exponentials are ___much___ easier to work with.
Copy link
Member

Choose a reason for hiding this comment

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

Me either. All of the examples I've found have shown the unit circle and how things translate (rotate) when put on the complex plane. this rundown from Real Python uses a (contrived) example of the Bermuda Triangle. Very tempted to adapt it with a different region of the globe. Or maybe we use a simple geometric form and how it can be flipped and rotated easier on the complex plane. URG. More thought needed on my part, clearly.

colinleach and others added 7 commits November 28, 2023 19:02
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
@colinleach
Copy link
Contributor Author

I'm supportive of an optimistic merge, with the option to circle back later for more revisions. Launching an exercise would have all sorts of downstream implications that are hard to reverse, but a concept seems relatively low-impact.

@BethanyG
Copy link
Member

I'm too full of Pineapple fried rice right now to concentrate, but I'll put together and intro.md for review tomorrow, and then we can merge. 😄

@BethanyG
Copy link
Member

BethanyG commented Dec 5, 2023

So I think what you were seeing on your commit history with the title of introduction.md is not present here.

So I am going to merge this and the Fractions one in about 5 min. 😄 LMK if you have any further corrections or objections!

@colinleach
Copy link
Contributor Author

Great, press the button!

@BethanyG BethanyG merged commit fea327b into exercism:main Dec 5, 2023
8 checks passed
@BethanyG
Copy link
Member

BethanyG commented Dec 5, 2023

MERGED 🎆

@colinleach colinleach deleted the complex-numbers branch December 5, 2023 22:01
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.

2 participants