Page MenuHomePhabricator
Differential D19640

Improve some documentation for "diffusion.commit.search"
ClosedPublic
Actions

Authored by epriestley on Sep 5 2018, 4:34 PM.
Tags
None
Referenced Files
F13250683: D19640.diff
Fri, May 24, 4:17 PM
F13230892: D19640.diff
Mon, May 20, 11:23 PM
F13189346: D19640.diff
Sat, May 11, 5:53 AM
Unknown Object (File)
Sun, May 5, 6:17 PM
Unknown Object (File)
Apr 24 2024, 11:47 PM
Unknown Object (File)
Apr 18 2024, 2:07 AM
Unknown Object (File)
Apr 14 2024, 1:32 PM
Unknown Object (File)
Apr 14 2024, 7:44 AM
View All 98 Files
Subscribers
None

Details

Reviewers
amckinley
Maniphest Tasks
T13195: 2018 Week 36 Bonus Content
Commits
rPa20f0674a985: Improve some documentation for "diffusion.commit.search"
Summary

Ref T13195. See PHI851. Start by making some minor improvements here:

  • Clarify that the example of what constraints look like is just an example.
  • Add descriptions for parameters missing descriptions.
Test Plan

Looked at API method page, saw more helpful/complete instructions.

Diff Detail

Repository
rP Phabricator
Branch
auditoptions1
Lint
Lint Passed
Unit
Tests Passed
Build Status
Buildable 20742
Build 28203: Run Core Tests
Build 28202: arc lint + arc unit

Event Timeline

epriestley created this revision.Sep 5 2018, 4:34 PM
Harbormaster completed remote builds in B20742: Diff 46934.Sep 5 2018, 4:35 PM
epriestley requested review of this revision.Sep 5 2018, 4:35 PM
amckinley accepted this revision.Sep 5 2018, 10:44 PM

You could change almost all the new wordings to say "where a given set of blah blah blah", but that's just being nitpicky. I think this is fine as-is.

This revision is now accepted and ready to land.Sep 5 2018, 10:44 PM
epriestley updated this revision to Diff 46944.Sep 6 2018, 3:36 PM
  • Trim out a bit of code from elsewhere.
Harbormaster completed remote builds in B20752: Diff 46944.Sep 6 2018, 3:37 PM
Closed by commit rPa20f0674a985: Improve some documentation for "diffusion.commit.search" (authored by epriestley). · Explain WhySep 6 2018, 3:39 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathSize
src/
applications/
audit/
query/
25 lines
dashboard/
paneltype/
31 lines
search/
engine/
4 lines

Diff 46934

View Options

src/applications/audit/query/PhabricatorCommitSearchEngine.php

Loading...
View Options

src/applications/dashboard/paneltype/PhabricatorDashboardQueryPanelType.php

Loading...
View Options

src/applications/search/engine/PhabricatorSearchEngineAPIMethod.php

Loading...
Phabricator · Built by Phacility