Skip to content

Fix formatting in README for 01-setup-and-first-steps #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sebastiantecsi wants to merge 3 commits into
base: main
Choose a base branch
from
+2 −2
Open

Fix formatting in README for 01-setup-and-first-steps #87

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9fcaead
Fix formatting of allow-all command in README
sebastiantecsi Apr 17, 2026
b3af7f4
Clarify instruction for summarizing utils.py
sebastiantecsi Apr 17, 2026
cacf681
Update 01-setup-and-first-steps/README.md
sebastiantecsi Apr 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions 01-setup-and-first-steps/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -422,7 +422,7 @@ That's it for getting started! As you become comfortable, you can explore additi
| Command | What It Does |
|---------|--------------|
| `/add-dir <directory>` | Add a directory to allowed list |
| `/allow-all [on|off|show]` | Auto-approve all permission prompts; use `on` to enable, `off` to disable, `show` to check current status |
| `/allow-all [on\|off\|show]` | Auto-approve all permission prompts; use `on` to enable, `off` to disable, `show` to check current status |
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The backslashes in /allow-all [on\|off\|show] are inside an inline code span, so they will render literally (showing \|) rather than escaping the table delimiter. Consider reverting to /allow-all [on|off|show] inside backticks (GFM tables handle | inside code spans), or use an HTML entity for the pipe if you need to support parsers that don’t.

Suggested change
| `/allow-all [on\|off\|show]` | Auto-approve all permission prompts; use `on` to enable, `off` to disable, `show` to check current status |
| `/allow-all [on|off|show]` | Auto-approve all permission prompts; use `on` to enable, `off` to disable, `show` to check current status |

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Author

@sebastiantecsi sebastiantecsi Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In fact \| is escaping the table delimiter, and that's what we need. Otherwise /allow-all [on|off|show] renders multiple | aka table delimiters.

cc @copilot

| `/yolo` | Quick alias for `/allow-all on` — auto-approves all permission prompts. |
| `/cwd`, `/cd [directory]` | View or change working directory |
| `/list-dirs` | Show all allowed directories |
Expand Down Expand Up @@ -594,7 +594,7 @@ Additional details about remote sessions can be found in the [Copilot CLI docs](
The hands-on examples focused on reviewing and refactoring `book_app.py`. Now practice the same skills on a different file, `utils.py`:

1. Start an interactive session: `copilot`
2. Ask Copilot CLI to summarize the file: `@samples/book-app-project/utils.py What does each function in this file do?`
2. Ask Copilot CLI to summarize the file: `@samples/book-app-project/utils.py` and what does each function in this file do?
Comment thread
sebastiantecsi marked this conversation as resolved.
Outdated
3. Ask it to add input validation: "Add validation to `get_user_choice()` so it handles empty input and non-numeric entries"
4. Ask it to improve error handling: "What happens if `get_book_details()` receives an empty string for the title? Add guards for that."
5. Ask for a docstring: "Add a comprehensive docstring to `get_book_details()` with parameter descriptions and return values"
Expand Down
Loading