Links

Multi-file examples on coding practices

Multi-file examples allow you to show a practice example that implies more than one file. You can have one multi-file example per practice. A multi-file example is an ordered list of practice examples.
You can view a practice multi-files example in the practice details modal by clicking on Multi-file Example tab.

Send a multi-file example from IDE plugins

This feature is available for the following IDE plugins and their associated versions :
  • VSCode: 8.1.0 or higher
  • JetBrains: 7.1.0 or higher
  • Visual Studio: 5.2.0 or higher
  • Eclipse: 🚧 WIP 🚧
When you chose to identify a practice, there are two fields to edit the example details:
  • A description textarea, to give some context for this specific example
  • A checkbox, to specify if we include this specific example in the multi-file examples of the practice
As you can see on the two screenshots below, this is available when you are creating a new practice or when you are identifying an existing one.
Example details configuration for practice creation on VSCode
Example details configuration for existing practice on VSCode

Configure multi-file example

You can edit the multi-file example by clicking the Edit button at the bottom of the multi-file example.
In this view, you can add practice examples to the multi-files example, remove examples, change the order of examples, and edit example descriptions.

Edit example description

By clicking on the description of one example, an input will show, allowing you to edit the example description. It will be saved as soon as you click outside of the description block. The example description supports Markdown syntax.

Change examples order

You can change examples order by clicking the chevron on the left of each example.
The up chevron will change the example rank by one up.
The down chevron will change the example rank by one down.