Skip to content

Commit

Permalink
retitle some pages
Browse files Browse the repository at this point in the history
Summary:
The Pysa and Pyre docs have pages/headings w/ the same title, it's hard to know which link to click in the search results.

{F1929891194}

Reviewed By: rchen152

Differential Revision: D64350218

fbshipit-source-id: 01d0a9e11fdf33074ca7629d90b9a4b843ca6dc5
  • Loading branch information
yangdanny97 authored and facebook-github-bot committed Oct 14, 2024
1 parent a55ae02 commit 87df5c4
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions documentation/website/docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: configuration
title: Configuration
title: Pyre Configuration
sidebar_label: Configuration
---
<!-- There is a separate page for internal config at ./fb/configuration.md. When making changes, please keep common docs in sync. -->
Expand Down Expand Up @@ -78,7 +78,7 @@ provides typed stubs for library functions.

- `strict`: Setting this to `true` will make [strict mode](gradual_typing.md#strict-mode) the default in your project.

- `python_version`: This is expected to be a string of the form "X.Y.Z" which specifies what version of Python the checked code is expected to be executed with. By default, the version is set to the same as the Python interpreter that runs `pyre` itself.
- `python_version`: This is expected to be a string of the form "X.Y.Z" which specifies what version of Python the checked code is expected to be executed with. By default, the version is set to the same as the Python interpreter that runs `pyre` itself.

Note: Since Pyre does not run your code, the setting of Python version tends to have relatively small impact on the type checker's behavior. Currently, Pyre only uses Python version to syntactically resolve version conditions of [certain form](https://github.com/python/typeshed/blob/main/CONTRIBUTING.md#stub-versioning).

Expand Down
4 changes: 2 additions & 2 deletions documentation/website/docs/features.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: features
title: Features
sidebar_label: Features
title: Pyre-Exclusive Features
sidebar_label: Pyre-Exclusive Features
---

Pyre has custom support for Python idioms that would otherwise not be supported by the usual type annotations.
Expand Down
2 changes: 1 addition & 1 deletion documentation/website/docs/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getting-started
title: Getting Started
title: Getting Started with Pyre
sidebar_label: Getting Started
---
import {OssOnly, FbInternalOnly} from 'docusaurus-plugin-internaldocs-fb/internal';
Expand Down
4 changes: 2 additions & 2 deletions documentation/website/docs/pysa_basics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: pysa-basics
title: Overview
title: Pysa Overview
sidebar_label: Overview
---

Expand Down Expand Up @@ -61,7 +61,7 @@ some_sink(x.some_attribute) # This is also detected
some_sink(x.__class__) # This is (unfortunately) also detected
```

## Configuration
## Pysa Configuration

Pysa uses two types of files for configuration: a single `taint.config` file,
and an unlimited number of files with a `.pysa` extension. The `taint.config`
Expand Down

0 comments on commit 87df5c4

Please sign in to comment.