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

Update troubleshooting guide #319

Merged
merged 2 commits into from
Oct 31, 2024
Merged

Conversation

chiphogg
Copy link
Contributor

The biggest change is that we add a new section for the new kind of
error, when users try to pass something to a QuantityMaker even though
it's already a Quantity (and similar for QuantityPoint).

We also update the guidance to recommend unblock_int_div instead of
the obsolete integer_quotient.

Other than that, the PR basically consists of running the build under
the five configurations shown here, and copy-pasting error messages.
Most changes are just line number tweaks. Some changed implementation
details do show up in the error messages. Also, sometimes the compiler
changed to be more or less verbose.

The details of the changes aren't really important (assuming that I
copy-pasted correctly). It's just an update.

Fixes #288.

The biggest change is that we add a new section for the new kind of
error, when users try to pass something to a `QuantityMaker` even though
it's already a `Quantity` (and similar for `QuantityPoint`).

We also update the guidance to recommend `unblock_int_div` instead of
the obsolete `integer_quotient`.

Other than that, the PR basically consists of running the build under
the five configurations shown here, and copy-pasting error messages.
Most changes are just line number tweaks.  Some changed implementation
details do show up in the error messages.  Also, sometimes the compiler
changed to be more or less verbose.

The details of the changes aren't really important (assuming that I
copy-pasted correctly).  It's just an update.

Fixes #288.
@chiphogg chiphogg added the release notes: 📝 documentation PR affecting library documentation label Oct 31, 2024
@chiphogg chiphogg requested a review from geoffviola October 31, 2024 01:31
Copy link
Contributor

@geoffviola geoffviola left a comment

Choose a reason for hiding this comment

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

Thanks for providing an example, refreshing the error messages, and documenting the new error. The new error looks clearer 😄

D:\a\au\au\au.hh(2334): error C2338: Elements must be listed in ascending order
error_examples.cc(113): note: see reference to function template instantiation 'bool au::operator ==<au::Quarterfeet,au::Trinches,int,int>(au::Quantity<au::Quarterfeet,int>,au::Quantity<au::Trinches,int>)' being compiled
D:\a\au\au\au.hh(3132): error C2338: Elements must be listed in ascending order
D:\a\au\au\au.hh(1310): note: see reference to class template instantiation 'au::CommonUnit<T,au::Quarterfeet>' being compiled
Copy link
Contributor

Choose a reason for hiding this comment

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

It's a little surprising this error got longer.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I thought so too.

@chiphogg chiphogg merged commit b6f05e3 into main Oct 31, 2024
11 checks passed
@chiphogg chiphogg deleted the chiphogg/update-troubleshoot#288 branch October 31, 2024 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release notes: 📝 documentation PR affecting library documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation - QuantityMaker(QuantityD) troubleshooting
2 participants