Skip to content

[VS Code] Ask students to ignore un-related checkstyle guides #163

Description

@TobyCyan

While going through the VS Code - Setting up Checkstyle tutorial, I noticed on step 1, there is reference made towards Checkstyle config files by a link being included (i.e. here). The link takes the students to the Using Checkstyle page, which includes other Checkstyle setup guides such as for gradle and IDEA.

In my understanding, these other Checkstyle guides are un-related to VSCode/ students at that moment but please correct me if I'm wrong.

Hence, I think we could consider telling students to ignore the un-related Checkstyle setup guides (i.e. Using Checkstyle with Gradle & Using Checkstyle-IDEA plugin), otherwise students may get confused as they are not sure whether they should follow them and end up wasting their time.

Image

Clicking on the link redirects to the Using Checkstyle page with other setup guides.
Image

Additional screenshot to prove that Checkstyle still works without following the other guides.
Image

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions