yahoo-eng-team team mailing list archive

[Roger Luethi <rl@xxxxxxxxxxxxxxxxxxxx>]

Public bug reported:

A recent review made me wonder about how we are using weight in the
documentation. When OpenStack talks about weight, it doesn't mean mass
but a statistical property.

Such properties are used when "weighting" the members of a class, when
producing a weighted average or a weighted index. But some of the
OpenStack documentation talks about "weighing".

Here are some samples from nova docs:

Correct:
# If we speak about `filtering` and `weighting`, their work is quite
# flexible in the Filter Scheduler.

Incorrect:
# During its work Filter Scheduler firstly makes dictionary of unfiltered
# hosts, then filters them using filter properties and finally chooses hosts
# for the requested number of instances (each time it chooses the most weighed
# host and appends it to the list of selected hosts).

Unfortunately, the API docs are sometimes rather unhelpful, containing
explanations like this gem:

# def weight_multiplier(self):
# """How weighted this weigher should be.

Related (in openstack-manuals): bug 1335423

** Affects: nova
     Importance: Undecided
         Status: New


** Tags: documentation

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1335554

Title:
  Documentation: incorrect use of "weighted"

Status in OpenStack Compute (Nova):
  New

Bug description:
  A recent review made me wonder about how we are using weight in the
  documentation. When OpenStack talks about weight, it doesn't mean mass
  but a statistical property.

  Such properties are used when "weighting" the members of a class, when
  producing a weighted average or a weighted index. But some of the
  OpenStack documentation talks about "weighing".

  Here are some samples from nova docs:

  Correct:
  # If we speak about `filtering` and `weighting`, their work is quite
  # flexible in the Filter Scheduler.

  Incorrect:
  # During its work Filter Scheduler firstly makes dictionary of unfiltered
  # hosts, then filters them using filter properties and finally chooses hosts
  # for the requested number of instances (each time it chooses the most weighed
  # host and appends it to the list of selected hosts).

  Unfortunately, the API docs are sometimes rather unhelpful, containing
  explanations like this gem:

  # def weight_multiplier(self):
  # """How weighted this weigher should be.

  Related (in openstack-manuals): bug 1335423

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1335554/+subscriptions