Commit 8405ee5
update docs for env vars (#1987)
This updates docs for #1949
I feel like we shouldn't explicitly talk about lazy loading env vars,
it's just extra information for a programming language user. It should
just work out of the box.
<!-- ELLIPSIS_HIDDEN -->
----
> [!IMPORTANT]
> Update documentation for environment variables, including deprecation
warnings and new examples for Python, TypeScript, and Ruby.
>
> - **Documentation Updates**:
> - Removed redundant section "Setting Environment Variables" from
`env-vars.mdx`.
> - Added deprecation warning for `reset_baml_env_vars` in `config.mdx`.
> - Updated `with_options.mdx` to include `env` parameter in examples
for Python, TypeScript, and Ruby.
> - Updated `setting-env-vars.mdx` to remove outdated examples and
clarify usage of `dotenv` in Python, TypeScript, and Ruby.
> - **Behavior**:
> - Environment variables are now lazily loaded on each function call,
as noted in `config.mdx`.
>
> <sup>This description was created by </sup>[<img alt="Ellipsis"
src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=BoundaryML%2Fbaml&utm_source=github&utm_medium=referral)<sup>
for 1ddf894. You can
[customize](https://app.ellipsis.dev/BoundaryML/settings/summaries) this
summary. It will automatically update as commits are pushed.</sup>
<!-- ELLIPSIS_HIDDEN -->
---------
Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>1 parent 0b645e3 commit 8405ee5
4 files changed
Lines changed: 12 additions & 59 deletions
File tree
- fern
- 03-reference
- baml_client
- baml
- snippets
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
24 | | - | |
25 | 24 | | |
26 | 25 | | |
27 | 26 | | |
| |||
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | | - | |
33 | | - | |
34 | | - | |
35 | | - | |
36 | | - | |
37 | | - | |
38 | | - | |
39 | | - | |
40 | | - | |
41 | | - | |
42 | | - | |
43 | | - | |
44 | | - | |
45 | | - | |
46 | | - | |
47 | 32 | | |
48 | 33 | | |
49 | 34 | | |
50 | 35 | | |
51 | | - | |
| 36 | + | |
52 | 37 | | |
53 | 38 | | |
54 | 39 | | |
| |||
58 | 43 | | |
59 | 44 | | |
60 | 45 | | |
61 | | - | |
62 | 46 | | |
63 | 47 | | |
64 | 48 | | |
65 | 49 | | |
66 | 50 | | |
67 | 51 | | |
68 | | - | |
69 | | - | |
70 | | - | |
71 | 52 | | |
72 | 53 | | |
73 | 54 | | |
74 | 55 | | |
75 | | - | |
76 | | - | |
77 | | - | |
78 | | - | |
79 | | - | |
80 | | - | |
81 | | - | |
82 | | - | |
83 | | - | |
84 | | - | |
85 | | - | |
86 | | - | |
87 | | - | |
88 | | - | |
89 | | - | |
90 | | - | |
91 | | - | |
92 | | - | |
93 | | - | |
94 | | - | |
95 | | - | |
96 | | - | |
97 | | - | |
98 | | - | |
99 | | - | |
100 | | - | |
101 | | - | |
102 | | - | |
103 | | - | |
104 | | - | |
105 | | - | |
106 | | - | |
107 | | - | |
108 | | - | |
109 | | - | |
0 commit comments