You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I expect that automatic formatting of Q# files will be done on the scale of the entire repo - in CI, during publishing, etc. Typically, it means that there's an action that formats the entire codebase. However it isn't always desirable to autoformat everything. There may be very small number of exceptions. For example, if the author needs to express specific structure in the code, some esoteric aligning or even a test of a compiler of whitespace handling.
In this case it is desirable to specifically exclude portion of the code from auto-formatting. Something like "auto-format all my Q# files except this code fragment". The granularity could be a code block or something similar. The directive could be similar to #pragma(DoNotAutoformat).
The alternative could be "not do anything". This would require user to carefully exclude certain file from autoformat in scripts and while saving. Given that the author of the code is typically not the person who runs scripts and saves files, it may require a lot of careful manual handling.
I expect that automatic formatting of Q# files will be done on the scale of the entire repo - in CI, during publishing, etc. Typically, it means that there's an action that formats the entire codebase. However it isn't always desirable to autoformat everything. There may be very small number of exceptions. For example, if the author needs to express specific structure in the code, some esoteric aligning or even a test of a compiler of whitespace handling.
In this case it is desirable to specifically exclude portion of the code from auto-formatting. Something like "auto-format all my Q# files except this code fragment". The granularity could be a code block or something similar. The directive could be similar to #pragma(DoNotAutoformat).
The alternative could be "not do anything". This would require user to carefully exclude certain file from autoformat in scripts and while saving. Given that the author of the code is typically not the person who runs scripts and saves files, it may require a lot of careful manual handling.
(Result of a discussion here: #1303)
The text was updated successfully, but these errors were encountered: