Add mechanism to verify that source code in documentation is valid #7951

Activity

1. andygrove

   added

   enhancementNew feature or requestNew feature or request

   devrel

   on Oct 27, 2023
2. andygrove

   self-assigned this

   on Oct 27, 2023
3. andygrove

   changed the title [-]Make sure that all code samples in the documentation are tested automatically[/-] [+]Add mechanism to verify that source code in documentation is valid[/+] on Oct 28, 2023
4. alamb commented on Aug 20, 2024

   

   alamb

   on Aug 20, 2024

   Contributor

   More actions

   I believe this is now handled via the doctest macro, for example:

   datafusion/datafusion/core/src/lib.rs

   Lines 618 to 643 in 37e54ee

   	// Instructions for Documentation Examples
   	//
   	// The following commands test the examples from the user guide as part of
   	// `cargo test --doc`
   	//
   	// # Adding new tests:
   	//
   	// Simply add code like this to your .md file and ensure your md file is
   	// included in the lists below.
   	//
   	// ```rust
   	// <code here will be tested>
   	// ```
   	//
   	// Note that sometimes it helps to author the doctest as a standalone program
   	// first, and then copy it into the user guide.
   	//
   	// # Debugging Test Failures
   	//
   	// Unfortunately, the line numbers reported by doctest do not correspond to the
   	// line numbers of in the .md files. Thus, if a doctest fails, use the name of
   	// the test to find the relevant file in the list below, and then find the
   	// example in that file to fix.
   	//
   	// For example, if `user_guide_expressions(line 123)` fails,
   	// go to `docs/source/user-guide/expressions.md` to find the relevant problem.
5. alamb

   closed this as completedon Aug 20, 2024
6. alamb

   added

   documentationImprovements or additions to documentationImprovements or additions to documentation

   on Aug 20, 2024