Skip to content

bazel/README.md: add aspell comment #17072

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

Merged
phlax merged 3 commits into from
Jul 5, 2021
Merged

bazel/README.md: add aspell comment #17072

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c42ec3d
bazel/README.md: add aspell comment
daixiang0 Jun 22, 2021
92076ab
feedback
daixiang0 Jun 24, 2021
0377175
feedback
daixiang0 Jun 28, 2021
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
2 changes: 1 addition & 1 deletion bazel/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -874,7 +874,7 @@ to run clang-format scripts on your workstation directly:

To run the tools directly, you must install the correct version of clang. This
may change over time, check the version of clang in the docker image. You must
also have 'buildifier' installed from the bazel distribution.
also have 'buildifier' installed from the bazel distribution and `aspell`.

@alyssawilk alyssawilk Jun 22, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

actually in retrospect maybe have the same 's around buildifier and aspell?

/wait

@daixiang0 daixiang0 Jun 24, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

sorry I do not get key :(

@phlax phlax Jun 22, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

im not sure if this is the correct place to put this - given that currently aspell is required for running the python script and isnt activated via bazel - altho this may change after

@daixiang0 daixiang0 Jun 23, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I do not find a good place to put it, maybe a new line for it?

@phlax phlax Jun 24, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

i think that information about aspell should not be in this file - there is no bazel job that depends on it - this file is mostly about setting up a bazel environment - info on linting is not relevant here and is wierdly misplaced

that said - its already like that and there is information about running the spell checker below

perhaps add it there - something like "if you wish to run spellchecking please install aspell"

even that tho doesnt really cover it - eg if you install on debian/ubuntu aspell as so apt install --no-install-recommends aspell it wont work correctly - as you need the en dictionaries that are pulled in as recommends

i think this info - like the information about linting - has no place on this page

@daixiang0 daixiang0 Jun 24, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This section is "Running clang-format without docker", it covers more things indeed, why not rename it as something like "Running format without docker" and comment its dependence like aspell?

@phlax phlax Jun 24, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

rename it as something like "Running format without docker"

my preference would be "Linting your code without docker"

i still think we need to move this section - but agree its beyond the scope of this change

if you want to add information about the aspell dependency - please make it clear that its required for running the check_spelling.py script - not for running the other format tools

@daixiang0 daixiang0 Jun 24, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done.

let us do it step by step :)


Edit the paths shown here to reflect the installation locations on your system:

Expand Down