The Wayback Machine - https://web.archive.org/web/20211108062212/https://github.com/pytorch/pytorch/pull/56487
Skip to content
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.

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

Jump to bottom

Add remaining ToCs to ToC lint #56487

Closed
wants to merge 5 commits into from
Closed

Add remaining ToCs to ToC lint #56487

wants to merge 5 commits into from

Conversation

Reviewers

@seemethere seemethere

@janeyx99 janeyx99

@Sifat1998 Sifat1998

Assignees
No one assigned
Labels
cla signed Merged
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants
@samestep @facebook-github-bot @seemethere @janeyx99 @Sifat1998
@samestep
Copy link
Contributor

@samestep samestep commented Apr 20, 2021 •
edited
Loading

The lint was originally added in #54974, but at the time I didn't realize that these other Markdown files also each have a table of contents:

  • GLOSSARY.md
  • torch/csrc/jit/OVERVIEW.md
  • torch/csrc/jit/docs/serialization.md
  • torch/fx/OVERVIEW.md

This PR adds those files to the lint, and also changes the rule from using a fixed list of filenames to a git grep command that finds all Markdown files containing this magic comment:

<!-- toc -->

Test plan:

The "Lint / toc" job in GitHub Actions.
@samestep
Add GLOSSARY.md to ToC lint
b6f970e
@facebook-github-bot
Copy link
Contributor

@facebook-github-bot facebook-github-bot commented Apr 20, 2021 •
edited
Loading

💊 CI failures summary and remediations

As of commit 969d244 (more details on the Dr. CI page):

💚 💚 Looks good so far! There are no failures yet. 💚 💚

This comment was automatically generated by Dr. CI (expand for details).Follow this link to opt-out of these comments for your Pull Requests.

Please report bugs/suggestions to the (internal) Dr. CI Users group.

Loading

samestep added 4 commits Apr 20, 2021
@samestep
Fix lint
c4f4bdd
@samestep
Add remaining ToC-containing .md files to lint
07e3cf2
@samestep
Replace file list with git grep for magic comment
0a05de3
@samestep
Fix remaining discrepancies
969d244
@samestep samestep changed the title Add GLOSSARY.md to ToC lint Add remaining ToCs to ToC lint Apr 20, 2021
@facebook-github-bot
Copy link
Contributor

@facebook-github-bot facebook-github-bot commented Apr 20, 2021

@samestep has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

Loading

@samestep samestep marked this pull request as ready for review Apr 20, 2021
@samestep samestep requested a review from Apr 20, 2021
@facebook-github-bot
Copy link
Contributor

@facebook-github-bot facebook-github-bot commented Apr 20, 2021

@samestep merged this pull request in 75651e3.

Loading

krshrimali pushed a commit to krshrimali/pytorch that referenced this issue May 19, 2021
@samestep Kushashwa Shrimali
Add remaining ToCs to ToC lint (pytorch#56487)
ea84d4f 
Summary:
The lint was originally added in pytorch#54974, but at the time I didn't realize that these other Markdown files also each have a table of contents:

- `GLOSSARY.md`
- `torch/csrc/jit/OVERVIEW.md`
- `torch/csrc/jit/docs/serialization.md`
- `torch/fx/OVERVIEW.md`

This PR adds those files to the lint, and also changes the rule from using a fixed list of filenames to a `git grep` command that finds all Markdown files containing this magic comment:

```md

```

Pull Request resolved: pytorch#56487

Test Plan: The "Lint / toc" job in GitHub Actions.

Reviewed By: janeyx99

Differential Revision: D27884885

Pulled By: samestep

fbshipit-source-id: 5462437502b17fba93abf5098e21754bf566a4fe
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment