Moodle

Confusing phpDocs block for $DB->record_exists()

Details

  • Type: Sub-task Sub-task
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: 2.2.2
  • Fix Version/s: 2.2.3
  • Component/s: Database SQL/XMLDB
  • Labels:

Description

The documentation of the record_exists() contains a relict from 1.x version that is not valid any more and can be very confusing for developers:

  • The record to test is specified by giving up to three fields that must
  • equal the corresponding values.

I am suggesting to remove these two lines completely

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Michael de Raadt added a comment -

Hi, Apu.

I thought you might want to tackle this as you have recenly been working on the phpDocs for this API.

Show
Michael de Raadt added a comment - Hi, Apu. I thought you might want to tackle this as you have recenly been working on the phpDocs for this API.
Hide
Permalink
Aparup Banerjee added a comment -

yup thanks, patch is up for review.

Show
Aparup Banerjee added a comment - yup thanks, patch is up for review.
Hide
Permalink
Petr Škoda added a comment -

looks ok, please submit for integration

Show
Petr Škoda added a comment - looks ok, please submit for integration
Hide
Permalink
Andrew Davis added a comment -

Looks like a good change. Consider also rewriting "Test whether a record exists in a table where all the given conditions met."

Maybe something like...

"Test whether a record that satisfies the supplied conditions exists."

Or something.

Show
Andrew Davis added a comment - Looks like a good change. Consider also rewriting "Test whether a record exists in a table where all the given conditions met." Maybe something like... "Test whether a record that satisfies the supplied conditions exists." Or something.
Hide
Permalink
Dan Poltawski added a comment -

Thanks, that has been integrated now.

Show
Dan Poltawski added a comment - Thanks, that has been integrated now.
Hide
Permalink
Dan Poltawski added a comment -

Passing test - comment removed succesfully

Show
Dan Poltawski added a comment - Passing test - comment removed succesfully
Hide
Permalink
Eloy Lafuente (stronk7) added a comment -

And this has landed upstream, finally! Yay!

תודה רבה && شكرا جزيلا



Closing, ciao

Show
Eloy Lafuente (stronk7) added a comment - And this has landed upstream, finally! Yay! תודה רבה && شكرا جزيلا Closing, ciao

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: