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

docs(ref): Provide guidance on version requirements #12323

Merged
merged 1 commit into from
Jul 5, 2023

Commits on Jun 30, 2023

  1. docs(ref): Provide guidance on version requirements

    I've been dealing with these situations as either the package author,
    depending on such a package, or supporting users who run into problems
    that I figure documenting this guidance in a central place means I won't
    have to repeat myself as often and have to re-find all of the relevant
    links each time.
    
    Alternatives to how this was documented
    - Use a regular header.  All of sections in this document are flat and
      its hard to see association between them.  This also feels like its
      more on the level of the "note"s.
    - Put this in a central Recommendations page.  I think we should do
      something more for these when we have more (nothing else in my quick
      scan stood out as "recommendations" like this).  At that point we can
      have a better idea of how it would work (much like the rule of 3 for
      generalizing code).  I also suspect a "Recommendations" index might be
      better.
    - Put this in the FAQ.  This can easily be framed as a question and we
      put the `Cargo.lock` policy in there.
    
    I left out talking about alternative proc-macro designs as I feel like
    treading new ground in community practices is out of the scope of this.
    
    See also https://rust-lang.zulipchat.com/#narrow/stream/246057-t-cargo/topic/Version.20Requirements.20documentation
    epage committed Jun 30, 2023
    Configuration menu
    Copy the full SHA
    6c37c34 View commit details
    Browse the repository at this point in the history