Reordering comments on modules

[cgravill]

Issue created from fantomas-online

Code

// Boring copyright notice

(* Some other preamble *)

/// This module is amazing it's full of helpful lookup queries
module Queries

Result

/// This module is amazing it's full of helpful lookup queries
// Boring copyright notice

(* Some other preamble *)

module Queries

Problem description

It's not exactly an issue but it's a change between Fantomas 4.6.0 and 4.7.1 - I can narrow down the version where it occurred if that helps.

We have a somewhat common requirement to stick a copyright at the top of files to make lawyers happy. That copyright (with //) is now swapped with module level code comments (with ///). It all works but it's fairly ugly.

No problem if this is intended behaviour, I'll find a way around it if needed.

Extra information

• The formatted result breaks by code.
• The formatted result gives compiler warnings.
• I or my company would be willing to help fix this.

Options

Fantomas master branch at 2022-03-10T17:18:56Z - c455e63

Default Fantomas configuration

_{Did you know that you can ignore files when formatting from fantomas-tool or the FAKE targets by using a .fantomasignore file?}

[cgravill]

In case it helps my case:

https://github.com/dotnet/fsharp/blob/d7bb97023b749298a4c0efc317c0797c7696201c/src/fsharp/AccessibilityLogic.fs#L1-L4

(Apologies if this crosses into stylistic discussion. It came as a behaviour change between versions which I wanted to check on. I can seek a ruling elsewhere)

[nojaf]

Hey Colin, please try out https://www.nuget.org/packages/fantomas-tool/4.7.2

[cgravill]

Amazing response time, thanks!

As a "reward" I've got more reports incoming. :-)

[nojaf]

🙈😅 I already regret publishing 4.7 🙃
Also, somewhat related: https://blog.nojaf.com/2022/03/05/a-word-on-triple-slash-comments
Maybe some other problems you have are related to this as well.

[cgravill]

Ah ha, you've already caught at least one: #2143

[nojaf]

Yep, this going to be a bigger evil than I anticipated.

[cgravill]

btw generally 4.7 is a nice improvement for us, fixes a bunch we were marked as ignore or manually reverting.

[nojaf]

That is nice to hear, thank you for this feedback.