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

Add support non-English words in docstring arguments #6307

Merged
merged 4 commits into from
Nov 15, 2023

Conversation

bschnurr
Copy link
Member

@bschnurr bschnurr commented Nov 2, 2023

This comment has been minimized.

This comment has been minimized.

@erictraut
Copy link
Collaborator

@bschnurr, looks like the tests are failing for this PR. If you'd like to get this into this week's pyright release, please fix the tests and merge the PR.

@Aruelius
Copy link

Aruelius commented Nov 9, 2023

hi @erictraut

maybe the regex can be

!line?.endsWith(':') && !line?.endsWith('::') && !!line.match(/^\s*.*?\S+(\s*\(.*?\))*\s*:\s*/g);

cause it seems not that important to match the content to right of the :.

@Aruelius
Copy link

Do we have any updates here?

Maybe I can open a new PR if this PR doesn't progress anymore.

@erictraut
Copy link
Collaborator

@bschnurr, any update on this PR?

…ict with invalid types in the google doc style with invalid types.

This comment has been minimized.

@@ -746,31 +746,6 @@ Returns:
_testConvertToMarkdown(docstring, markdown);
});

test('GoogleWithInvalidTypes', () => {
Copy link
Member Author

Choose a reason for hiding this comment

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

Now that are regex is very relaxed we are keeping the line break in this example. so its no longer a failure case.

Copy link
Contributor

According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅

@bschnurr
Copy link
Member Author

done

@Aruelius
Copy link

thank you guys very much!

@erictraut erictraut merged commit eeb5f11 into microsoft:main Nov 15, 2023
12 checks passed
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.

docstring: Regarding Korean line spacing problem
5 participants