[Functools] Concept Introduction Docs

[Tarun193]

No description provided.

[Tarun193]

Can someone please review it, and I was not to able to complete this whole task as I am busy in some other work.
But if there is some help required , just ask me out.

[BethanyG]

@Tarun193 - My sincere apologies! I got very bogged down with things and have not gotten to writing the functools docs or reviewing all the PRs I should have. This looks good as a general functools concept introduction.

I was not to able to complete this whole task as I am busy in some other work.

Does this mean you no longer want to work on issue #2366? If that is the case, I will merge this introduction as-is, and un-assign you from the other tasks. When someone picks up the full exercise, they can review and revise this introduction as they complete the other work.

Just let me know - thanks!

[Tarun193]

@BethanyG hey, sorry replying late , I just wrote the about document of the concept can you please check it.

[BethanyG]

@Tarun193 -- Thank you for getting a start on the about.md concept doc! I've left a few comments. Before I talk about the content, I just want to give you a few reminders on our Markdown Specifications, and our Writing Style Guide. In particular, you should be using Markdown Reference-Style Links, and making sure that each sentence is on its own line.

My initial comments show an example of each of these techniques. Rather than comment on each formatting or link instance (since these docs are going to need revisions, and re-formatting will add noise), I think it would be cleaner if when you did your next revisions, you rework the remainder of the links and the sentences to conform to the specifications. If you could also update the introduction.md as well, that would be terrific.

Moving on to the content. I want to apologize - decorators (except for the use of @functools.wraps()) should not be part of this exercise nor part of the about.md for functools. Decorators have their own concept exercise and concept docs, which is a prerequisite to this exercise and these concepts. So your section on decorators should be re-worked to only talk about the pros and cons of using @functools.wraps() when writing decorators, rather than introducing decorators as a full topic, or giving examples of how to write one. I have updated the functools exercise spec to reflect this.

Likewise, there is no need to talk about what a higher-order function is, since that will have been covered in the Higher-Order-Functions exercise.

Now for some things that should be included that haven't been included yet.

For functools.partial() we' want to call out the three different "flavors" of objects produced explicitly with some prose as well as code examples. So we want to be specific about what partial.func, partial.args, and partial.keywords are, give clear examples of how using partial() in different ways creates them, and how using them behaves in code. We also want to introduce functools.partialmethod(), and explain what the difference between the two are (one is for use with methods in a class vs a stand-alone function).

Like with functools.partial()and functools.partialmethod, we want to explain how functools.singledispatch() and functools.singledispatchmethod() are the function and method (bound to a class) versions of the same generic function process, and give clear examples of what that looks like in code.

Finally, we want to cover functools.cache(), functools.lru_cache(), and functools.update_wrapper

I have updated the spec and removed @functools.cached_property() (it feels like it belongs to an exercise on class customization instead) and @functools.total.orderg (it belongs with rich comparisons).

I am going to leave my feedback at that for now, and save more in-depth review for after you've added in the additional functions and methods. I've also converted this to a draft PR, so that we can continue to make large revisions without sending out review notifications. I will convert it back into a "regular" PR as we get closer to finalizing things.

Please let me know if you have any questions or issues, and apologies again for the delay in getting you feedback. Thank you for all your hard work on this!

[Tarun193]

Sorry for not replying.
Hey I just updated the about and introduction file according to the new requirements of the concept.
@BethanyG can you please check it.

[BethanyG]

Hi @Tarun193 👋🏽

Thanks for updating this with the new requirements. I really appreciate it.

Since the comments on this PR are getting quite long and noisy, I am going to approve this as-is and optimistically merge it. Should you want to continue working on it more, we can pick up discussions in a follow-on PR. Let me know if you have any questions or issues.

[Tarun193]

Hi @BethanyG 👋
thanks for your appreciation.
No I don't want to work on it any more as the about section is good enough according to me and I don't have idea for exercise.
But if you want some some improvements feel free ask me. I will do it as per suggestions.
Thanks.