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

intro_tutorial: Warn user the Mesa version must be up-to-date #1743

Merged
merged 1 commit into from
Jul 27, 2023

Conversation

rht
Copy link
Contributor

@rht rht commented Jul 26, 2023

No description provided.

@codecov
Copy link

codecov bot commented Jul 26, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (0663e02) 72.29% compared to head (ac56e63) 72.29%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1743   +/-   ##
=======================================
  Coverage   72.29%   72.29%           
=======================================
  Files          20       20           
  Lines        1303     1303           
  Branches      246      246           
=======================================
  Hits          942      942           
  Misses        326      326           
  Partials       35       35           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Corvince
Copy link
Contributor

I'm a bit worried about the maintenance burden of this change. This would need to be updated for every version change.

The docs are already versioned. While not 100% optimal I think it is ultimately the users responsibility to check the correct version. Otherwise we would need this reminder on top of every documentation page.

Also >= 2.1 is misleading. We don't know if it will work in 2.x (also it should ) or 3.x

@Corvince
Copy link
Contributor

That said some advice might actually be a good idea at least for the intro tutorial. But maybe just rephrase it so that users should check that the doc version and installed version matches.

@rht rht changed the title intro_tutorial: Warn user the minimum required Mesa version intro_tutorial: Warn user the Mesa version must be up-to-date Jul 27, 2023
@rht
Copy link
Contributor Author

rht commented Jul 27, 2023

I have made the warning to be more generic.

@rht rht merged commit f1e3e97 into projectmesa:main Jul 27, 2023
11 checks passed
@tpike3 tpike3 added this to the Mesa 2.1.1 (Avondale) milestone Jul 30, 2023
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