Skip to content

Commit d667f75

Browse files
authored
Adding some style instructions
1 parent 8d691ed commit d667f75

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

.gemini/styleguide.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,10 @@ Most of the cookbook content is Colab notebooks, which are stored as Json.
3131

3232
* Include the collapsed license at the top (uses the Colab "Form" mode to hide the cells).
3333
* Use one `H1` header (`#` in Markdown) for the title.
34-
* Include the "open in colab" button immediately after the `H1`.
34+
* Include the "open in colab" button immediately after the `H1`. It should look like
35+
`<a target=\"_blank\" href=\"URL\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" height=30/>`
3536
* Include an overview section before any code.
37+
* use %pip instead of !pip
3638
* Put the imports when they are first used.
3739
* Keep code as brief as possible.
3840
* Break text cells at headings
@@ -99,6 +101,7 @@ Most of the cookbook content is Colab notebooks, which are stored as Json.
99101
}
100102
)
101103
```
104+
Notice the line break on the first and last lines.
102105
* Long text variables should use triple double quotes and proper indentation for better readability:
103106
```python
104107
long_prompt = """
@@ -108,6 +111,7 @@ Most of the cookbook content is Colab notebooks, which are stored as Json.
108111
Lemon drops tootsie roll marshmallow halvah carrot cake.
109112
"""
110113
```
114+
Notice the line break on the first and last lines.
111115

112116
## Naming Conventions
113117

0 commit comments

Comments
 (0)