diff --git a/docs/src/DB.md b/docs/src/DB.md index 78b9863..7b63406 100644 --- a/docs/src/DB.md +++ b/docs/src/DB.md @@ -11,25 +11,26 @@ intended for package development. ## Usage -Retrieve a benchmark using its key: - -```julia-repl -julia> entry = TwoBody.db(:hydrogen) +```@example db-usage +using TwoBody +``` -julia> entry.hamiltonian +Retrieve a benchmark using its key: -julia> entry.energy +```@repl db-usage +entry = TwoBody.db(:hydrogen) +entry.hamiltonian +entry.energy ``` Add a benchmark using `TwoBody.put!`: -```julia-repl -julia> hamiltonian = Hamiltonian( - Kinetic(ℏ = 1.0, m = 1.0), - Coulomb(coefficient = -1.0), - ) - -julia> TwoBody.put!(:example, hamiltonian, -0.5) +```@repl db-usage +hamiltonian = Hamiltonian( + Kinetic(ℏ = 1.0, m = 1.0), + Coulomb(coefficient = -1.0), +) +TwoBody.put!(:example, hamiltonian, -0.5) ``` Duplicate keys are rejected, and Hamiltonians are copied on registration and