rust documentation demo 2 - my preferreed way of running documentation tests

Channel:
Singapore Theo Ong Science and Engineering
Subscribers:
9,750
Published on ● Video Link: https://www.youtube.com/watch?v=aY_oHpAB9Dg


Duration: 19:10
188 views
2

------------------ Useful Links ------------------------------------
cargo watch
https://crates.io/crates/cargo-watch

lint to warn about missing docs
https://doc.rust-lang.org/rustdoc/lints.html

cargo doc
https://doc.rust-lang.org/cargo/commands/cargo-doc.html

cargo test
https://doc.rust-lang.org/cargo/commands/cargo-test.html

rust documentation comments (credits for teaching me)
https://www.youtube.com/watch?v=hcxSN9nBJEY

doc tests don't work in main.rs
https://github.com/rust-lang/rust/issues/50784

How to include a library in your main file
https://dev.to/yjdoc2/make-a-combined-library-and-binary-project-in-rust-d4f



------------------ Video Sections --------------------------------
Chapters:
0:00 Intro and Setup
2:20 code example documentation in rust
5:55 documentation tests
6:15 cargo test does not work with main file, you need to have doc tests in the library
7:55 making a library rust file in the same cargo project
12:55 fixing compile time bugs
15:25 navigating to the new documentation
18:25 Conclusion

---------------------[Playlists and Relevant Github Repositories]----------------------------------------------

Fluid Mechanics and Git Repos:
https://www.youtube.com/playlist?list=PLhPfNw4V4_YSmdAXc6J0XOSQ1b27qsMGt
https://github.com/theodoreOnzGit/OpenFoam_heatTrf_YouTube

Petroleum Downstream Crash Course Playlist:
https://www.youtube.com/playlist?list=PLhPfNw4V4_YQ13CnhacUqEVk-tZlU4ISE

OpenFOAM for Windows 10 Beginner Playlist and some Git Repos
https://www.youtube.com/playlist?list=PLhPfNw4V4_YRhBU4IqSaToQ8_X543YQsZ
https://github.com/theodoreOnzGit/laminar_BL_OpenFOAM

OpenFOAM Intermediate Playlist and some Git Repos
https://www.youtube.com/playlist?list=PLhPfNw4V4_YSpWX6mSOlwWEOKVa6i_iuE
https://github.com/theodoreOnzGit/thin_pipeflow_snappyHexMesh

OpenFOAM Heat Transfer Playlist and GitHub Repo
https://www.youtube.com/playlist?list=PLhPfNw4V4_YR2Qa3Q9-AzNSF2J9Dc4_qT
https://github.com/theodoreOnzGit/OpenFoam_heatTrf_YouTube

Convection Boundary Layer and git Repos:
https://www.youtube.com/playlist?list=PLhPfNw4V4_YR9pRBpp101Mkuds49vjQ63
https://github.com/theodoreOnzGit/heatTransferTheory_YouTube

Turbulence Modelling Playlist
https://www.youtube.com/watch?v=F_Rxv9uMM3g&list=PLhPfNw4V4_YSnbYkJIBQ1kRN06Mmxe2Be
https://github.com/theodoreOnzGit/turbulenceModelling

Control Systems and Frequency Response
https://www.youtube.com/watch?v=qHY6y7JmB2U&list=PLhPfNw4V4_YRUuWnrtClovPKxU_gJOXH-
https://github.com/theodoreOnzGit/matlabFrequencyResponse.git

OpenFOAM C++
https://github.com/theodoreOnzGit/C-_YouTube_OpenFoam
https://www.youtube.com/playlist?list=PLhPfNw4V4_YT9OgqS7ZPlot_Ucxzc6pQJ

OpenFOAM Bash
https://github.com/theodoreOnzGit/Bash_OpenFOAM_YouTube
https://www.youtube.com/playlist?list=PLhPfNw4V4_YT5zjBhfj5Hj4r4D5eXilcU

Basic Samba
https://www.youtube.com/playlist?list=PLhPfNw4V4_YQuWJLufBUpNplitReZX0fB
https://github.com/theodoreOnzGit/sambaVideos

Manjaro Tips and Tricks
https://www.youtube.com/playlist?list=PLhPfNw4V4_YQuyXBfJxAvzHJTl0UiWx3h

lammps and Discrete Element Modelling (DEM)
https://www.youtube.com/playlist?list=PLhPfNw4V4_YTdRlnLiu2OUXeTf5ZNVQ9E

playing with dotnet core
https://www.youtube.com/playlist?list=PLhPfNw4V4_YQSTR8sqz0aRVzWlQBq3QUw
dotnet core github repo
https://github.com/theodoreOnzGit/dotnetCoreYoutube



Other Videos By Theo Ong Science and Engineering


2023-03-02Uncertainty Propagation Python Metrolopy - basics
2023-02-25Connect virtualbox samba share to windows using wsdd messy debug and walkthrough
2023-02-12add arrow to libreoffice calc chart
2023-01-13rust opcua - how the polling action timers work
2023-01-13rust opcua - use closures (polling actions) to modify opcua variable values
2023-01-13rust opcua - add read and write variables to opcua server
2023-01-13rust opcua print your endpoint periodically
2023-01-13rust opcua - build an anonymous user server and connect to it via a python GUI client
2023-01-12Connecting to OPCUA Rust Server in Linux PC via OPCUA python client GUI on Windows PC
2023-01-05Engineering Can or Not Plastic Waste for Roads and Iron Ore my own fun video
2022-10-16rust documentation demo 2 - my preferreed way of running documentation tests
2022-10-15rust documentation demo 1 - my personalised setup with cargo watch and nvim
2022-09-25I tried doing latex in vim or neovim without the vimtex plugin compile for fun learning experience
2022-09-15Units Safe Calculations for Rust Newbies 2 - checking dimensionless numbers and unit conversions
2022-09-14Units Safe Calculations in Rust Rust Newbies 1 - Calculating Reynolds Number demo 2022
2022-09-13exploring asyncio opcua in python 7 - installing opcua client on windows using winpython
2022-09-12exploring asyncio opcua in python 6 - demo:python server calculating darcy friction factor with rust
2022-09-12exploring asyncio opcua in python 5 add method and using nodemon to watch python files
2022-09-11OPCUA NetStandard2 0 9 - A hiatus for opcua C sharp code
2022-09-09OPCUA NetStandard2.0 8 - Coding a "simple" temperature sensor OPCUA object via csharp
2022-09-09OPCUA NetStandard2.0 7 - Coding a "simple" temperature sensor OPCUA objectType (class) via csharp


Tags:
Engineering
Math
Science
Thermodynamics
Fluid Mechanics
Chemical
Nuclear
Chemical Potential
Fugacity
Enthalpy
Internal Energy
Entropy
First Law
Second law
Gibbs Free Energy
Hemholtz free energy
heat capacity
constant volume
constant pressure
tutorial
petroleum
oil
refinery
downstream
crude
jet
gasoline
gasoil
diesel
computational fluid dynamics
CFD
OpenFoam
Open
Foam
Fluid mechanics
heat transfer
turbulence
conduction
convection
radiation
Linux
Mint
Ubuntu
Manjaro