← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1722072] [NEW] Wrong path of rpc_api.rst in class docstring

 

Public bug reported:

In few class docstrings rpc_api.rst file path is not correct. 
Given path is "doc/source/devref/rpc_api.rst" but, I found this file at this path "/doc/source/contributor/internals/rpc_api.rst" (https://github.com/openstack/neutron/blob/master/doc/source/contributor/internals/rpc_api.rst)


test@test-Standard-PC-i440FX-PIIX-1996:~/bug/neutron$ grep -nri rpc_api.rst
neutron/agent/dhcp/agent.py:78: changing rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/agent/dhcp/agent.py:538: about changing rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/agent/rpc.py:72: information on changing rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/agent/metadata/agent.py:56: doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/securitygroups_rpc.py:40:interfaces, see doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/securitygroups_rpc.py:68: rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/securitygroups_rpc.py:129:rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/securitygroups_rpc.py:167: changing rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/dvr_rpc.py:33: rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/dvr_rpc.py:74: interfaces, see doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/dhcp_rpc.py:51:changing rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/metadata_rpc.py:29: doc/source/devref/rpc_api.rst.
neutron/api/rpc/agentnotifiers/dhcp_rpc_agent_api.py:39:rpc interfaces, please see doc/source/devref/rpc_api.rst.
neutron/db/agents_db.py:400: information on changing rpc interfaces, see doc/source/devref/rpc_api.rst.

If this is valid bug then, Can I prepare a patch for this?

** Affects: neutron
     Importance: Undecided
         Status: New

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to neutron.
https://bugs.launchpad.net/bugs/1722072

Title:
  Wrong path of rpc_api.rst in class docstring

Status in neutron:
  New

Bug description:
  In few class docstrings rpc_api.rst file path is not correct. 
  Given path is "doc/source/devref/rpc_api.rst" but, I found this file at this path "/doc/source/contributor/internals/rpc_api.rst" (https://github.com/openstack/neutron/blob/master/doc/source/contributor/internals/rpc_api.rst)

  
  test@test-Standard-PC-i440FX-PIIX-1996:~/bug/neutron$ grep -nri rpc_api.rst
  neutron/agent/dhcp/agent.py:78: changing rpc interfaces, see doc/source/devref/rpc_api.rst.
  neutron/agent/dhcp/agent.py:538: about changing rpc interfaces, see doc/source/devref/rpc_api.rst.
  neutron/agent/rpc.py:72: information on changing rpc interfaces, see doc/source/devref/rpc_api.rst.
  neutron/agent/metadata/agent.py:56: doc/source/devref/rpc_api.rst.
  neutron/api/rpc/handlers/securitygroups_rpc.py:40:interfaces, see doc/source/devref/rpc_api.rst.
  neutron/api/rpc/handlers/securitygroups_rpc.py:68: rpc interfaces, see doc/source/devref/rpc_api.rst.
  neutron/api/rpc/handlers/securitygroups_rpc.py:129:rpc interfaces, see doc/source/devref/rpc_api.rst.
  neutron/api/rpc/handlers/securitygroups_rpc.py:167: changing rpc interfaces, see doc/source/devref/rpc_api.rst.
  neutron/api/rpc/handlers/dvr_rpc.py:33: rpc interfaces, see doc/source/devref/rpc_api.rst.
  neutron/api/rpc/handlers/dvr_rpc.py:74: interfaces, see doc/source/devref/rpc_api.rst.
  neutron/api/rpc/handlers/dhcp_rpc.py:51:changing rpc interfaces, see doc/source/devref/rpc_api.rst.
  neutron/api/rpc/handlers/metadata_rpc.py:29: doc/source/devref/rpc_api.rst.
  neutron/api/rpc/agentnotifiers/dhcp_rpc_agent_api.py:39:rpc interfaces, please see doc/source/devref/rpc_api.rst.
  neutron/db/agents_db.py:400: information on changing rpc interfaces, see doc/source/devref/rpc_api.rst.

  If this is valid bug then, Can I prepare a patch for this?

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


Follow ups