From f36b61c273744686912e80d2580a164ffa3e1c6f Mon Sep 17 00:00:00 2001 From: Julia Silge Date: Fri, 11 Oct 2024 12:11:47 -0600 Subject: [PATCH] Edit that will fail vale linter --- 404.qmd | 2 +- data-explorer.qmd | 2 +- extensions.qmd | 8 ++++---- faqs.qmd | 2 +- feedback.qmd | 2 +- start.qmd | 4 ++-- updating.qmd | 4 ++-- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/404.qmd b/404.qmd index 93ec46a..20d5353 100644 --- a/404.qmd +++ b/404.qmd @@ -3,4 +3,4 @@ title: "Page Not Found" format: html --- -Oops! The page you requested isn't available. Try [searching our documentation](/404.qmd?q=%20&show-results=1) or find out [how to get started](start.qmd) with Positron. \ No newline at end of file +Oops! The page you requested is not available. Try [searching our documentation](/404.qmd?q=%20&show-results=1) or find out [how to get started](start.qmd) with Positron. \ No newline at end of file diff --git a/data-explorer.qmd b/data-explorer.qmd index e3998a1..b015849 100644 --- a/data-explorer.qmd +++ b/data-explorer.qmd @@ -2,7 +2,7 @@ title: "Data Explorer" --- -The Data Explorer is designed to complement code-first exploration of data, allowing you to display data in a spreadsheet-like grid, temporarily filter and sort data, and provide useful summary statistics directly inside of Positron. The goal of the Data Explorer isn't to replace code-based workflows, but rather supplement with ephemeral views of the data or summary statistics as you further explore or modify the data via code. +The Data Explorer is designed to complement code-first exploration of data, allowing you to display data in a spreadsheet-like grid, temporarily filter and sort data, and provide useful summary statistics directly inside of Positron. The goal of the Data Explorer is not to replace code-based workflows, but rather supplement with ephemeral views of the data or summary statistics as you further explore or modify the data via code. The Data Explorer has three primary components, discussed in greater detail in the sections below: diff --git a/extensions.qmd b/extensions.qmd index c5c2e74..046af4c 100644 --- a/extensions.qmd +++ b/extensions.qmd @@ -5,12 +5,12 @@ title: "Extensions" Since Positron is built on [Code OSS](https://github.com/microsoft/vscode), you can use VS Code extensions in Positron. Your extensions installed for Positron are _separate_ from the extensions you have installed for VS Code, and they won't interfere with each other. Positron bundles several extensions, including those for Quarto, Jupyter notebooks, and Pyright. To see bundled extensions, search for `@builtin` under the Extensions tab. To further filter the list, you can add a search term, such as `@builtin Positron` :::{.callout-note} -Positron doesn't currently bundle the [Shiny](https://open-vsx.org/extension/posit/shiny) extension, so you will need to install that if you want to use it. +Positron does not currently bundle the [Shiny](https://open-vsx.org/extension/posit/shiny) extension, so you will need to install that if you want to use it. ::: ### Installing extensions -Positron has an Extensions view, just like VS Code. The primary difference is that when you browse extensions in Positron, the extensions don't come from VS Code's Marketplace. Instead, they come from a third-party marketplace, [OpenVSX](https://open-vsx.org/). This is necessary for licensing reasons; Microsoft doesn't permit access to the Marketplace from non-official clients. +Positron has an Extensions view, just like VS Code. The primary difference is that when you browse extensions in Positron, the extensions don't come from VS Code's Marketplace. Instead, they come from a third-party marketplace, [OpenVSX](https://open-vsx.org/). This is necessary for licensing reasons; Microsoft does not permit access to the Marketplace from non-official clients. OpenVSX includes most popular VS Code extensions, but not all; some authors don't bother to publish their extensions to OpenVSX (it's an extra step) and others don't keep the OpenVSX version of the extension up to date. Open VSX has a suggested [template](https://github.com/open-vsx/publish-extensions/blob/master/docs/external_contribution_request.md) to request that the authors of an extension cross-publish their extension on the Open VSX Registry. @@ -24,7 +24,7 @@ In offline or other environments, users may need to manually install extensions Almost all extensions for Visual Studio Code work great with Positron, and in fact Positron is built with this kind of extensibility in mind. There are two known exceptions: -- [R extension](https://marketplace.visualstudio.com/items?itemName=REditorSupport.r): The R language support in Positron is a direct replacement for the features in this extension, and we don't plan for them to work well together. If there are features in this extension you miss, please let us know. If you use this extension and have code in your `.Rprofile` for better behavior in the terminal, you will need to update it so that section of your `.Rprofile` isn't run in Positron: +- [R extension](https://marketplace.visualstudio.com/items?itemName=REditorSupport.r): The R language support in Positron is a direct replacement for the features in this extension, and we don't plan for them to work well together. If there are features in this extension you miss, please let us know. If you use this extension and have code in your `.Rprofile` for better behavior in the terminal, you will need to update it so that section of your `.Rprofile` is not run in Positron: ```r if (interactive() && Sys.getenv("RSTUDIO") == "" && Sys.getenv("POSITRON") == "") { @@ -32,6 +32,6 @@ if (interactive() && Sys.getenv("RSTUDIO") == "" && Sys.getenv("POSITRON") == "" } ``` -- [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python): Positron bundles a fork of this extension that's built to work with Positron and offers support for the console, help, and other features. If there is anything from the original Python extension that doesn't work for you, please let us know. +- [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python): Positron bundles a fork of this extension that's built to work with Positron and offers support for the console, help, and other features. If there is anything from the original Python extension that does not work for you, please let us know. There may be extensions that aren't available for Positron for licensing rather than technical reasons. These extensions would typically contain proprietary Microsoft code and are only licensed for use with Microsoft's proprietary VS Code product. diff --git a/faqs.qmd b/faqs.qmd index 67a5424..fac43e7 100644 --- a/faqs.qmd +++ b/faqs.qmd @@ -18,7 +18,7 @@ title: "Frequently Asked Questions" ### Why build a new IDE rather than VS Code extensions? -* Our aspirations for Positron go far beyond what is possible via only extensions. Ultimately, VS Code's Extension API doesn't provide enough leverage to modify the main "workbench" surface. +* Our aspirations for Positron go far beyond what is possible via only extensions. Ultimately, VS Code's Extension API does not provide enough leverage to modify the main "workbench" surface. * To deliver a truly excellent data science experience, we need to change and augment core components and UI elements that are outside the scope of VS Code's extension API. * We have developed some components as extensions for use in both Positron and VS Code, such as Quarto and Shiny for R/Python. However, given the additional API surface in Positron, we plan to progressively enhance these and future extensions when installed in Positron. diff --git a/feedback.qmd b/feedback.qmd index 4176682..2486a9b 100644 --- a/feedback.qmd +++ b/feedback.qmd @@ -15,7 +15,7 @@ We're particularly interested in feedback on the following: - Ideas for features - What's missing - What works for you -- What doesn't +- What does not ## Reporting issues diff --git a/start.qmd b/start.qmd index 0a612e5..ce1315c 100644 --- a/start.qmd +++ b/start.qmd @@ -22,7 +22,7 @@ Positron is an early stage project under active development. We don't expect it ## Machine prerequisites -Before installing Positron, ensure your Python and/or R environments are ready to work with Positron. You don't need to install both, but Positron doesn't bundle either Python or R. +Before installing Positron, ensure your Python and/or R environments are ready to work with Positron. You don't need to install both, but Positron does not bundle either Python or R. ### Windows prerequisites @@ -38,7 +38,7 @@ Positron communicates with Python via the IPykernel package, so it needs to be i python3 -m pip install ipykernel ``` -Alternatively, Positron prompts you to install the IPykernel package if it isn't found when you initially try to use a Python environment. +Alternatively, Positron prompts you to install the IPykernel package if it is not found when you initially try to use a Python environment. ### R prerequisites diff --git a/updating.qmd b/updating.qmd index a3cc54c..c4f04b2 100644 --- a/updating.qmd +++ b/updating.qmd @@ -2,7 +2,7 @@ title: "Updating Positron" --- -Positron doesn't currently have a built-in update mechanism; you can [track our work on this feature on GitHub](https://github.com/posit-dev/positron/issues/1837). In the meantime, there are a few helpers available to you to manage manual updates. +Positron does not currently have a built-in update mechanism; you can [track our work on this feature on GitHub](https://github.com/posit-dev/positron/issues/1837). In the meantime, there are a few helpers available to you to manage manual updates. ## macOS @@ -23,7 +23,7 @@ Then you can download and install the latest version of Positron via: ``` :::{.callout-note} -Unfortunately, this approach doesn't check your current version of Positron; it will _always_ download and install the latest version. +Unfortunately, this approach does not check your current version of Positron; it will _always_ download and install the latest version. ::: ## Windows