Ticket #10444 (closed enhancement: fixed)

Opened 2 years ago

Last modified 10 months ago

Make solve documentation better

Reported by: kcrisman Owned by: mvngu
Priority: major Milestone: sage-5.3
Component: documentation Keywords: symbolic sd31
Cc: jason, burcin, dsm, benjaminfjones Work issues:
Report Upstream: N/A Reviewers: Benjamin Jones
Authors: Karl-Dieter Crisman Merged in: sage-5.3.beta0
Dependencies: Stopgaps:

Description (last modified by benjaminfjones) (diff)

To be precise, make sure the documentation at

sage: x.solve?

is available from

sage: solve?

There are a lot of keywords people are missing out on.


Apply to Sage library:

Attachments

trac_10444-solve.patch Download (3.4 KB) - added by kcrisman 10 months ago.
trac_10444_reviewer.patch Download (964 bytes) - added by benjaminfjones 10 months ago.
very small reviewer patch

Change History

comment:1 Changed 2 years ago by kcrisman

  • Cc jason, burcin added
  • Status changed from new to needs_review
  • Milestone set to sage-4.7.1

This patch at least begins to fix this issue. It just copies the most obvious examples. But I think it will help a lot.

Improvements welcome! Otherwise, please review.

comment:2 Changed 2 years ago by kcrisman

  • Keywords sd31 added

comment:3 Changed 2 years ago by travis

When applying the patch to my version 4.7, I received the error:

applying /home/travis/.sage/temp/euler.math.mc/4600/tmp_0.patch
patching file sage/symbolic/expression.pyx
Hunk #1 succeeded at 7365 with fuzz 2 (offset -44 lines).
patching file sage/symbolic/relation.py
Hunk #1 FAILED at 478
Hunk #3 succeeded at 625 with fuzz 2 (offset 2 lines).
1 out of 3 hunks FAILED -- saving rejects to file sage/symbolic/relation.py.rej
abort: patch failed to apply

Also, what was left over had some odd spacing issues when checking x.solve?

comment:4 Changed 2 years ago by kcrisman

  • Status changed from needs_review to needs_work
  • Work issues set to fix whitespace issues

This patch is based on 4.7.1.alpha2.

However, I see in the patch preview that for some reason there is extra whitespace, so I'll have to take care of that sometime. For now, needs work for that reason.

comment:5 Changed 10 months ago by kcrisman

Wow, I guess we let time forget this. Surprisingly, it still applies in the important place, and the stuff that doesn't apply is no longer needed.

Updated patch coming up.

Changed 10 months ago by kcrisman

comment:6 Changed 10 months ago by kcrisman

  • Cc dsm, benjaminfjones added
  • Status changed from needs_work to needs_review
  • Authors set to Karl-Dieter Crisman

Okay, this really needs to get in. Hopefully a quite easy review.

Changed 10 months ago by benjaminfjones

very small reviewer patch

comment:7 Changed 10 months ago by benjaminfjones

Looks really good. Thanks for taking care of this. I spotted two very small typos, a reviewer patch is attached. I'll set to positive review once I've checked out the html documentation, but everything looks good from the terminal!

comment:8 Changed 10 months ago by benjaminfjones

  • Status changed from needs_review to positive_review
  • Reviewers set to Benjamin Jones
  • Work issues fix whitespace issues deleted

OK, lookin' good. Positive review.

comment:9 Changed 10 months ago by benjaminfjones

  • Description modified (diff)

comment:10 Changed 10 months ago by jdemeyer

  • Status changed from positive_review to closed
  • Resolution set to fixed
  • Merged in set to sage-5.3.beta0
Note: See TracTickets for help on using tickets.