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

Change default version used in configuration website from master to latest 1.x #4633

Closed
calebcartwright opened this issue Jan 9, 2021 · 8 comments
Labels
documentation good first issue Issues up for grabs, also good candidates for new rustfmt contributors help wanted

Comments

@calebcartwright
Copy link
Member

rustfmt has a documentation site that enumerates all the configuration options available for a given version of rustfmt

https://rust-lang.github.io/rustfmt/

The site allows users to specify which version of rustfmt they want config documentation for, because the available/support config options can vary from one version of rustfmt to another (i.e. rustfmt v1.4.30 has different options than rustfmt v1.4.12)

The default rustfmt version used on the site is actually pointing the master branch in the rustfmt source repo itself. However, this has proven to be problematic because:

  • there's a huge difference between the configuration options in source control and the 1.x versions of rustfmt that are distributed and used by the community
  • most users still don't realize/understand they need to select the version on the config site to match the version of rustfmt they are actually using
  • there are comparatively very, very few users building and using rustfmt from source, so the current default of master is not a good default because it requires the vast majority of users to need to take an additional action on the config site.

The ask for this issue is to change that default from master to a different, new default. Ideally, the default could somehow be dynamically set to the latest (semver) v1.* version from the list, though if that proves impossible/too complex then simply hardcoding it to a different value (like v1.4.31) would suffice, and the rustfmt team will manually update that hardcoded value to the next value when we release a new version of rustfmt.

The code for the config site can be found here:
https://github.com/rust-lang/rustfmt/blob/master/docs/index.html

@calebcartwright calebcartwright added good first issue Issues up for grabs, also good candidates for new rustfmt contributors help wanted documentation labels Jan 9, 2021
@gunadhya
Copy link
Contributor

Hi @calebcartwright, I'd like to work on this issue.

@calebcartwright
Copy link
Member Author

@gunadhya - great, thanks!

@calebcartwright calebcartwright changed the title Change default version used in configuration website from masster to latest 1.x Change default version used in configuration website from master to latest 1.x Jan 14, 2021
@iwahbe
Copy link

iwahbe commented Apr 9, 2021

Should this issue still be open?

@calebcartwright
Copy link
Member Author

Should this issue still be open?

Yes indeed! Details in the PR linked to this issue #4644 (comment)

@hdost
Copy link

hdost commented Dec 1, 2021

It looks like this has been succesfully completed as the back port has also been complete #4958

@calebcartwright
Copy link
Member Author

It looks like this has been succesfully completed as the back port has also been complete #4958

@hdost - no, it hasn't. Please see my previous comment detailing why the issue is still open.

@gentoid
Copy link
Contributor

gentoid commented Aug 27, 2023

#4644 is already merged, and I checked https://rust-lang.github.io/rustfmt/ seems to be already fixed. So can this issue be closed?

@calebcartwright
Copy link
Member Author

Indeed, thanks all

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good first issue Issues up for grabs, also good candidates for new rustfmt contributors help wanted
Projects
None yet
Development

No branches or pull requests

5 participants