From 629b1780e5f70bb97ba9532dba1aac59e1ec2f81 Mon Sep 17 00:00:00 2001 From: Nick Thapen Date: Wed, 5 Jun 2024 09:33:48 +0100 Subject: [PATCH] docs: update walkthrough and welcome to reflect review in IDE (#247) --- package.json | 2 +- welcome-to-sourcery.py | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/package.json b/package.json index 183bdb8..ccb7ce2 100644 --- a/package.json +++ b/package.json @@ -95,7 +95,7 @@ { "id": "sourcery.openWelcomeFile", "title": "Explore Sourcery", - "description": "Get started by opening our tutorial \n[Open tutorial](command:toSide:sourcery.welcome.open)\n Ask Sourcery a question to improve your code. \n You can enable or disable the Sourcery Code Lenses above code for easy access. \n[Toggle Code Lens](command:sourcery.chat.toggleCodeLens)\n", + "description": "Get started by opening our tutorial \n[Open tutorial](command:toSide:sourcery.welcome.open)\n This will show you how to get code reviews straight in your IDE, as well as use the chat to ask questions \n You can enable or disable the Sourcery Code Lenses above code for easy access. \n[Toggle Code Lens](command:sourcery.chat.toggleCodeLens)\n", "media": { "markdown": "walkthrough/view_welcome_file.md" }, diff --git a/welcome-to-sourcery.py b/welcome-to-sourcery.py index b563e8d..99b6751 100644 --- a/welcome-to-sourcery.py +++ b/welcome-to-sourcery.py @@ -5,12 +5,12 @@ # (the hexagon) on your VS Code sidebar and click the login button, or open # the command palette (Ctrl/Cmd+Shift+P) and execute `Sourcery: Login`. -# Sourcery works in 2 ways: -# 1. A cloud-based AI powered coding assistant allowing you to ask it -# questions, write new code, and interact with existing code. To get -# started opt in via the Sourcery sidebar. -# 2. Local analysis to give you instant suggestions for improving your -# Python, JavaScript, and TypeScript code. +# Let's start with the coding assistant - to get started, opt in via the Sourcery sidebar. + +# The `Review` tab allows you to get a code review straight away in your IDE. +# You can choose between reviewing your current uncommitted changes and reviewing +# the changes between your current branch and the default branch. +# (Note that this will only work on code that is under Git version control). def days_between_dates(date1, date2): d1 = datetime.datetime.strptime(date1, '%Y-%m-%d').date() @@ -18,7 +18,7 @@ def days_between_dates(date1, date2): delta = d2 - d1 return delta.days -# Let's start with the coding assistant: +# Now let's move on to the `Chat` tab. # Above each function you'll see a few commands - these are Code Lenses that # you can use to interact with Sourcery. Try clicking on "Ask Sourcery" and # asking it to update the code to use `dateutil`. The answer will appear in