Skip to content

Is it possible to add a feature that allows Python DocStrings to be displayed in a target language (for example, in Chinese), or to utilize Copliot to automatically generate Chinese-language docstrings? #7679

@hujinsen

Description

@hujinsen

Python’s documentation strings provide explanations for the functions and objects, including how to use them and what precautions to take. However, for those who are not native English speakers, it can be quite difficult to fully understand these English-language documents. I have been learning English since junior high school; I continued to study it throughout high school, college, and graduate school. Although I can understand English documents, for me, English is merely a series of symbols. When reading English documents, my brain translates these symbols into Chinese in order for me to grasp their meaning. Nevertheless, when faced with a large number of English documentation strings, this process is very time-consuming, and it’s difficult to quickly understand the content of these documents.

Currently, there are no translation plugins that are capable of effectively translating entire documentation strings. Therefore, I hope that users will be given the option to specify the output language, so that hover tips and documentation strings within code can be displayed in the desired target language. This would greatly enhance the coding experience.

For these reasons, I dare to speak on behalf of non-English-speaking developers and request that the ability to output documentation strings in languages other than English be added. Thank you very much for your consideration! 🙏

Metadata

Metadata

Assignees

Labels

ai-triage-respondedIndicate whether the AI triage agent has responded to this issue.enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions