Skip to content

Commit a08dd9e

Browse files
committed
Clarify when (not) to read API section
1 parent 0972684 commit a08dd9e

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,16 @@ API
6262
===
6363

6464
The following section is the API Reference of MSAL Python.
65+
The API Reference is like a dictionary. You **read this API section when and only when**:
66+
67+
* You already followed our sample(s) above and have your app up and running,
68+
but want to know more on how you could tweak the authentication experience
69+
by using other optional parameters (there are plenty of them!)
70+
* You read the MSAL Python source code and found a helper function that is useful to you,
71+
then you would want to double check whether that helper is documented below.
72+
Only documented APIs are considered part of the MSAL Python public API,
73+
which are guaranteed to be backward-compatible in MSAL Python 1.x series.
74+
Undocumented internal helpers are subject to change anytime, without prior notice.
6575

6676
.. note::
6777

0 commit comments

Comments
 (0)