Skip to content

Commit 93fe2e8

Browse files
authored
Highlight that the code snippet will not work (#204)
Highlight that the code snippet will not work. Users most of the time will skim read the docs trying to spot snippets on how to use the code. Since this is the only snippet on the welcome page, we might want to highlight that it's an example that won't work.
1 parent 1db1f56 commit 93fe2e8

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ The core values of Injector are:
5050
a different configuration and each with different objects in different scopes. Code like this
5151
won't work for this very reason::
5252

53+
# This will NOT work:
54+
5355
class MyClass:
5456
@inject
5557
def __init__(self, t: SomeType):

0 commit comments

Comments
 (0)