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

Fix TestScope factory KDoc formatting #4321

Merged
merged 1 commit into from
Jan 7, 2025

Conversation

PhilGlass
Copy link
Contributor

@PhilGlass PhilGlass commented Jan 5, 2025

The docs for the TestScope factory function are supposed to include a nested list, but the indentation is wrong so the KDoc is a bit confusing.

Before:

Screenshot 2025-01-05 at 13 10 15

After:

Screenshot 2025-01-05 at 13 10 22

@PhilGlass PhilGlass changed the base branch from master to develop January 5, 2025 13:12
@fzhinkin fzhinkin added the docs KDoc and API reference label Jan 6, 2025
Copy link
Collaborator

@dkhalanskyjb dkhalanskyjb left a comment

Choose a reason for hiding this comment

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

Thanks! Could you target the master branch instead? From https://github.com/Kotlin/kotlinx.coroutines/blob/master/CONTRIBUTING.md :

Documentation in markdown files can be updated directly in the master branch, unless the documentation is in the source code, and the patch changes line numbers.

@PhilGlass PhilGlass changed the base branch from develop to master January 7, 2025 13:45
@PhilGlass
Copy link
Contributor Author

@dkhalanskyjb Done. FWIW I read that section and wasn't sure whether it applied to KDoc changes - it mentions markdown files, but this PR touches a Kotlin file with some KDoc/markdown in it. Perhaps worth clarifying.

@dkhalanskyjb dkhalanskyjb merged commit fed40ad into Kotlin:master Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs KDoc and API reference
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants