barunsaha commited on
Commit
5be3069
·
1 Parent(s): 9b00e1e

Update Copilot instructions

Browse files
Files changed (1) hide show
  1. .github/copilot-instructions.md +10 -2
.github/copilot-instructions.md CHANGED
@@ -1,6 +1,14 @@
1
- 1. In Python code, always use single quote for strings unless double quotes are necessary.
2
  2. When defining functions, always include type hints for parameters and return types.
3
  3. Except for logs, use f-strings for string formatting instead of other methods like % or .format().
4
  4. Use Google-style docstrings for all functions and classes.
5
  5. Two blank lines should precede top-level function and class definitions. One blank line between methods inside a class.
6
- 6. Max line length is 100 characters. Use brackets to break long lines. Wrap long strings inside ( and ).
 
 
 
 
 
 
 
 
 
1
+ 1. In Python code, always use single quote for strings unless double quotes are necessary. Use triple double quotes for docstrings.
2
  2. When defining functions, always include type hints for parameters and return types.
3
  3. Except for logs, use f-strings for string formatting instead of other methods like % or .format().
4
  4. Use Google-style docstrings for all functions and classes.
5
  5. Two blank lines should precede top-level function and class definitions. One blank line between methods inside a class.
6
+ 6. Max line length is 100 characters. Use brackets to break long lines. Wrap long strings (or expressions) inside ( and ).
7
+ 7. Split long lines at braces, e.g., like this:
8
+ my_function(
9
+ param1,
10
+ param2
11
+ )
12
+ NOT like this:
13
+ my_function(param1,
14
+ param2)