doc: refactor Function case to use write_section method #10037
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
In crates/doc/src/writer/as_doc.rs, there was a TODO comment in the ParseSource::Function case indicating that cleanup was needed. The implementation for this case used separate method calls for writing documentation and code, while other similar cases used the more concise write_section method.
This PR aims to improve code consistency and maintainability by standardizing the approach used across different parse source types.
Solution
The solution replaces multiple method calls with a single call to write_section, which handles both writing documentation and code in one operation:
This change brings the Function case in line with the implementation pattern used for Struct, Event, Error, and other parse source types.
PR Checklist