TransformerGenerator class extensive commenting

[alexaibio]

I am investigating your code in details and along the way made a lot of in-code commenting. Might be really useful for others studying this code, so I decided to PR.
I can continue if you like it

[subercui]

Hi @alexaibio, thank you so much for the efforts! Upon reflection, I propose an alternative approach: what if we include a hyperlink in our project's README directing users to your annotated branch, rather than proceeding with a pull request? The reason is mainly that commenting styles can vary based on different personal preferences, and there are best practices advocating for brevity in commenting such as this. I acknowledge the importance of ensuring that our code is as clear and self-explanatory as possible. We will try to do so while keeping the comments concise and following best practices. Looking forward to your thoughts on this.

[alexaibio]

Hi @subercui ,
Thank you for your prompt response. Since it's your code, it is totally fine not to incorporate my comments, and there's no necessity to include a link to my branch.
I appreciate the principle of commenting brevity. I just thought that offering additional links to the article content could improve the learning curve and is in fact a providing external links to the article content.