fix: correct executable compile docs to match signatures and flow #8737
+32
−5
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.
This change corrects misleading and outdated Rustdoc in cairo-lang-executable/src/compile.rs. The prepare_db() docs incorrectly stated it compiles a function by path and now accurately describe building a RootDatabase configured for #[executable], including cfg flags, plugin suite, corelib detection, and unsafe_panic handling. The compile_executable_function_in_prepared_db() docs previously listed a non-existent diagnostics_reporter parameter and claimed an Ok(Vec) return type; they now reflect the actual signature, the returned CompileExecutableResult<'db>, and clarify that diagnostics are ensured by the caller via ensure_diagnostics in compile_executable_in_prepared_db(). These updates align the documentation with the code and with the established pattern used in the Starknet compile module, removing ambiguity for users and maintainers.