Skip to content
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.

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

Improve docs #2993

Merged
merged 2 commits into from
Nov 20, 2023
Merged

Improve docs #2993

merged 2 commits into from
Nov 20, 2023

Conversation

cr3wdayt5p
Copy link

Improve docs:

  • Getting started:
    • Styling of install commands.
    • Remove references to the removed --recurse flag.
  • JetBrains rider:
    • Styling of install command.
    • Update screenshot.
    • Simplify info on Rider 2022.3 (and later) now respecting the default settings of fantomas (not really relevant to new users of F#/Fantomas). Also no need to have to keep this page updated will all current default settings.

mbk added 2 commits November 19, 2023 13:20
…the (outdated/irrelevant) Rider 2022.3 default settings update.
Copy link
Member

@dawedawe dawedawe left a comment

Choose a reason for hiding this comment

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

Great improvements @cr3wdayt5p . Thanks a lot!

@dawedawe dawedawe merged commit 21bae08 into fsprojects:main Nov 20, 2023
5 checks passed
@cr3wdayt5p cr3wdayt5p deleted the improve-docs branch November 20, 2023 09:34
```

<img class="mt-2" src="{{root}}/images/rider-fantomas.png" alt="drawing" width="70%"/>

Prior to Rider 2022.3 it did not [respect](https://youtrack.jetbrains.com/issue/RIDER-83997/Rider-doesnt-respect-Fantomas-default-settings-not-explicitly-set-in-editorconfig) the default settings of Fantomas.
Copy link
Contributor

Choose a reason for hiding this comment

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

Just a fun story to share: at some point Rider took the actual defaults from Fantomas and hardcoded them to its settings. Later Fantomas has changed the defaults, so the ones in Rider have become outdated, and for some time we were unfortunately stuck with them. It was never an intention to not respect the settings, just a coincidence of how the things have evolved here 🙂

Copy link
Author

Choose a reason for hiding this comment

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

I think that a lot of software evolve like that :) A "good enough" solution is often the best starting point, and then when/if it breaks it is easier to design the "good" solution (more knowledge available).

But Rider sure does have some fun formatting quirks :) It is pretty confusing to figure out what settings it applies and when. E.g. when I edit a .fsproj file it sort of uses a mix of the "code style" settings for XML-files (specified in the Settings UI), and the settings I have specified in .editorconfig – but this is not shown anywhere in settings UI (i.e. which settings are overriden by .editorconfig – or the way around). And then when Rider modifies .fsproj it uses a whole different set of formatting rules :)

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, the .fsproj story is also interesting. When editing the file manually then IntelliJ rules are used, but when Rider modifies it from code it actually delegates a lot of the work to MSBuild and it doesn't seem to follow what the rest of the IDE does. I'm not sure how easy/feasible it's to intercept the MSBuild modifications, but it seems it was difficult enough to become less prioritized.

Copy link
Author

Choose a reason for hiding this comment

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

Interesting. I thought Rider edited .fsproj directly.

That also kinda explains why you guys are hesitant to fix the single issue I have open on Rider:
https://youtrack.jetbrains.com/issue/RIDER-96647

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants