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 fill_auto_in_vec function doc test #1177

Merged
merged 1 commit into from
Sep 4, 2024
Merged

Conversation

guoard
Copy link
Contributor

@guoard guoard commented Sep 2, 2024

This PR fixes the documentation test (doctest) for the fill_auto_in_vec function, which was previously failing when running the command:

cargo test --doc

Changes Made:

  • Updated the doctest to use the .into() method for converting &str to String, ensuring type consistency without cluttering the test code.
  • Made the utils module public to ensure that the doctest can access the fill_auto_in_vec function correctly.

Consideration:

If these changes seem excessive or if maintaining the doctest is redundant (given that the function is already thoroughly tested in the test module within the same file), you might consider removing the doctest altogether to avoid duplicating efforts.

@coffee-cup coffee-cup added release/skip Author no release release/patch Author patch release and removed release/skip Author no release labels Sep 4, 2024
Copy link
Contributor

@coffee-cup coffee-cup left a comment

Choose a reason for hiding this comment

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

thanks!

@coffee-cup coffee-cup merged commit 7c8ac6e into railwayapp:main Sep 4, 2024
100 of 101 checks passed
@guoard guoard deleted the test_doc branch September 4, 2024 03:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release/patch Author patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants