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

[class-inheritance] Concept Documentation #2960

Merged
merged 31 commits into from
Jun 11, 2022
Merged

[class-inheritance] Concept Documentation #2960

merged 31 commits into from
Jun 11, 2022

Conversation

girijakar
Copy link
Contributor

@girijakar girijakar commented Feb 27, 2022

Concept documentation for issue #2351 #2972

@github-actions

This comment was marked as resolved.

@BethanyG BethanyG self-requested a review February 27, 2022 19:01
@BethanyG
Copy link
Member

Hi @girijakar 👋🏽

Thank you for submitting this PR. 😄 Were you intending to do a PR for issue #2350? There appears to be a lot of information about class members in this particular about doc that should go with class-customization (the prerequisite exercise to this one) and not class-inheritance.

The about docs for this concept -class-inheritance -should only cover and extend upon the bullet points listed in the Learning Objectives section of issue #2351 which are:

  • more fully understand the uses (and possible abuses) of classes in Python
  • understanding and use of single inheritance in Python
  • understanding and use of multiple inheritance in Python
  • the diamond inheritance problem
  • Pythons MRO (method resolution order)
  • pros and cos of mixins () to isolate multiple inheritance issues
  • when and when not to use __super__() to call a parent class constructor

Additionally, the concept introduction doc is missing from the set. It should be brief introduction to the concept topic.

Are you also going to work on the exercise for this concept? Both issue #2350 and #2351 are for concept exercises as opposed to concept docs -- although the concept docs can be submitted as part of the concept exercise.

Please let me know -- and if you are only working on the concept docs, I will write up a new issue for you.

@girijakar
Copy link
Contributor Author

Oh!
I want to work on #2351 issue for now. After finishing #2351 I'll try to give #2350 a go.

Can you tell me what other uses of class I can include for the first bullet point?
Is Introduction.md the concept introduction doc?

I apologize for the mistake 😶

@BethanyG BethanyG changed the title class-inheritance concept [class-customization] Concept Documentation Feb 28, 2022
@kotp kotp marked this pull request as draft February 28, 2022 23:40
@kotp
Copy link
Member

kotp commented Feb 28, 2022

I have set this to draft as it is not yet ready for review.

Is Introduction.md the concept introduction doc?

Yes.

more fully understand the uses (and possible abuses) of classes in Python
Can you tell me what other uses of class I can include for the first bullet point?

If you can think of at least 1 or 2, place them in the documentation. This can grow as you develop the documentation, I am sure you will realize other uses as it gets fleshed out.


Thank you for working on this!

@BethanyG BethanyG changed the title [class-customization] Concept Documentation [class-inheritance] Concept Documentation Mar 1, 2022
@girijakar
Copy link
Contributor Author

OK, but introduction.md doc is there in the set.

@BethanyG
Copy link
Member

BethanyG commented Mar 1, 2022

@girijakar - So it is! My apologies for missing it! I will give this a more through read-through in the morning my time (I'm in the pacific time zone). will you also be submitting the exercise portion of the issue in this PR or a follow on PR -- or are you only wanting to work on the concept as opposed to the exercise?

@girijakar
Copy link
Contributor Author

@BethanyG I want to work on the concept only for now ☺
Apologies for the delay in reply.

@BethanyG
Copy link
Member

BethanyG commented Mar 9, 2022

@girijakar - apologies for the delay! I've opened a new issue that covers just the concept documents. It's #2972. I've linked this PR to it.

girijakar and others added 2 commits March 14, 2022 22:51
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
@girijakar
Copy link
Contributor Author

girijakar commented Mar 14, 2022

@BethanyG Today I've commited your suggestions. Soon will work on rearranging/rewording/removing the concepts.

@BethanyG
Copy link
Member

@girijakar - That's awesome news! Thanks so much for working on this. I am a bit swamped with work, but will make sure to give this a good look over the weekend.

@BethanyG
Copy link
Member

@girijakar are you still working on this? Given its age, I am going to "optimistically merge" this as-is, and if you wish to continue working on revisions, you can submit a follow-on PR. Just ping and let us know.

I will file an improvement issue for these docs, and you are more than welcome to then pick that up. Thanks again for all your work on this! 💙

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.

Optimistically merging.

@BethanyG BethanyG marked this pull request as ready for review June 11, 2022 17:30
@BethanyG BethanyG merged commit ecd3724 into exercism:main Jun 11, 2022
@BethanyG BethanyG added x:rep/large Large amount of reputation x:size/large Large amount of work and removed x:rep/large Large amount of reputation labels Jun 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants