Code

Improve query API docs#4989

Code

Closed

Nilirad wants to merge 23 commits intobevyengine:mainbevyengine/bevy:mainfrom Nilirad:query_docsNilirad/bevy:query_docsCopy head branch name to clipboard

+641-517

Commits

Commits on Aug 8, 2022

• Squash and rebase

  Show description for a028341
  Nilirad

  committed
  a028341

• State that query creation has a time-constant cost

  Nilirad

  committed
  3bdb3b2

• Table vs sparse set query iteratino performance

  Nilirad

  committed
  a422f60

• Reference Query from WorldQuery

  Nilirad

  committed
  78f3707

• Remove WorldQuery repetition in second paragraph

  Nilirad

  committed
  9390982

• Add note about for_each vs iter performance

  Nilirad

  committed
  6070f96

• Remove implementation detail from performance section

  Nilirad

  committed
  87fc54c

• Reword for_each performance

  Nilirad

  committed
  6ea7bfb

• Remove for_each performance remarks from method descriptions

  Nilirad

  committed
  b8d11ff

• Add cross-links between iter and for_each methods

  Nilirad

  committed
  799bd66

• Apply @james7132 suggestion on for_each performance

  Show description for bcaede4
  

  Nilirad

  and

  james7132

  committed
  bcaede4

• Break doc comments at clause or sentence boundaries

  Nilirad

  committed
  5c02209

• Split long line

  Nilirad

  committed
  f45630c

• Migrate many_for_each_mut → iter_many_mut

  Nilirad

  committed
  14d6182

• Fix iter_many_mut description

  Nilirad

  committed
  1636b49

• Update to_readonly description

  Show description for be21bbd
  Nilirad

  committed
  be21bbd

• Ref-style link revision

  Show description for 90a3b16
  Nilirad

  committed
  90a3b16

• Move `WorldQuery safety section up

  Nilirad

  committed
  a0a4275

• Apply suggestions from code review

  Show description for 111ee3a
  

  Nilirad

  and

  rparrett

  committed
  111ee3a

• Apply diff-based suggestions

  Show description for b9d3cea
  

  Nilirad

  and

  BoxyUwU

  authored
  b9d3cea

• Remove duplicated and outdated “Safety” section

  Nilirad

  committed
  8950bfe

• Add link to State associated type

  Nilirad

  committed
  a6b56df

• Make clippy happy

  Nilirad

  committed
  706204f