Chapter 10. Object Storage command-line client - tempurl docs unformatted

Bug #1463081 reported by Thiago Paiva Brito
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
Low
Unassigned
python-swiftclient
Fix Released
Undecided
Andreas Jaeger

Bug Description

The positional and optional parameters on tempurl command are unformatted.

Tags: doc-tools
Revision history for this message
janonymous (janonymous) wrote :

Hi Thiago ,

   Could you point out the sections for the same?

Changed in openstack-manuals:
assignee: nobody → janonymous (janonymous)
janonymous (janonymous)
Changed in openstack-manuals:
status: New → In Progress
Revision history for this message
Andreas Jaeger (jaegerandi) wrote :

There's no information provided -> marking incomplete

Changed in openstack-manuals:
status: In Progress → Incomplete
Revision history for this message
janonymous (janonymous) wrote :

I have marked it confirmed as I think the information is adequate , i am working on the same.
It's the tempurl section only which is not formatted properly.

Changed in openstack-manuals:
status: Incomplete → Confirmed
Revision history for this message
Andreas Jaeger (jaegerandi) wrote :

janonymous, it's not adequate for me. Could you provide a link to the URL of this on docs.openstack.org, please?

janonymous (janonymous)
Changed in openstack-manuals:
status: Confirmed → In Progress
Revision history for this message
Thiago Paiva Brito (outbrito) wrote :
Revision history for this message
Andreas Jaeger (jaegerandi) wrote :

Note: This is autogenerated content. To update this, you need to update the tool that generates this content.

tags: added: doc-tools
removed: low-hanging-fruit
Changed in openstack-manuals:
importance: Undecided → Low
Revision history for this message
Andreas Jaeger (jaegerandi) wrote :

Thsi should be changed in swiftclient, let me fix it...

Revision history for this message
Andreas Jaeger (jaegerandi) wrote :

This needs to be updated in swiftclient, then a new release of swiftclient needs to be done and then the generated file can be regenerated to fix the openstack-manuals bug.

Revision history for this message
Andreas Jaeger (jaegerandi) wrote :
Changed in python-swiftclient:
status: New → In Progress
assignee: nobody → Andreas Jaeger (jaegerandi)
janonymous (janonymous)
Changed in openstack-manuals:
assignee: janonymous (janonymous) → nobody
Revision history for this message
janonymous (janonymous) wrote :

Nice work.
One more thing, in the same doc you could fix :
----------------------------
swift delete
Positional arguments

<container> --------------------->>> [container] ([] instead of <>)

    Name of container to delete from.
[object]

------------------------------

Revision history for this message
Andreas Jaeger (jaegerandi) wrote :

<> and [] have different meanings, this should not be changed.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-swiftclient (master)

Reviewed: https://review.openstack.org/189390
Committed: https://git.openstack.org/cgit/openstack/python-swiftclient/commit/?id=e48f487335e970f8b61a7f891118639203a746b8
Submitter: Jenkins
Branch: master

commit e48f487335e970f8b61a7f891118639203a746b8
Author: Andreas Jaeger <email address hidden>
Date: Mon Jun 8 20:20:21 2015 +0200

    Fix inconsistent usage of "Positional argument"

    All help texts uses "Positional argument" with the exception of tempurl.
    Update tempurl to use this as well so that the formatting tools work
    fine and can show this nicely on
    http://docs.openstack.org/cli-reference/content/swiftclient_commands.html#swiftclient_subcommand_tempurl
    like it's done for other options.

    Change-Id: Ib5502c23b236986bea5a4d4a63a46fca411a8494
    Closes-Bug: #1463081

Changed in python-swiftclient:
status: In Progress → Fix Committed
Tom Fifield (fifieldt)
Changed in openstack-manuals:
milestone: none → liberty
Revision history for this message
janonymous (janonymous) wrote :

Hi Andreas,

   Yes i know. but i think the section that i specified is different from others. Please compare once to confirm whether it is valid or not.

Tom Fifield (fifieldt)
Changed in openstack-manuals:
status: In Progress → New
Lana (loquacity)
Changed in openstack-manuals:
status: New → Fix Committed
Changed in python-swiftclient:
milestone: none → 2.5.0
status: Fix Committed → Fix Released
Changed in openstack-manuals:
milestone: liberty → mitaka
Changed in openstack-manuals:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.