Key:comment

From OpenStreetMap Wiki
Jump to: navigation, search
Available languages
Deutsch English français 日本語 polski русский
Public-images-osm logo.svg comment
Changeset comment.jpg
Description
A description of a changeset primarily for other mappers.
Group: Annotations
Used on these elements
should not be used on nodes
should not be used on ways
should not be used on areas
use on relations unspecified
See also
Status: De facto

The comment tag is used when describing changesets, and was introduced during API 0.6. It's used as a way for a mapper to describe what, or more interestingly, why, they made such changes. For example, when a node tagged with highway=bus_stop is moved, the changeset comment might be either "moved bus stop after recent roadworks" or "moved bus stop, was in wrong place". This can then help explain to other mappers why particular changes were made.

The comment tag is shown in various places on the website, notably in the history tab and other views involving changesets. Changeset comments are not mandatory. A changeset comment is a message to your fellow mappers, telling them what you did and why. Therefore, a meaningful message shows consideration for your fellow mappers.

Not taking the time to add such a message, or adding meaningless comments, is considered rude or disrespectful by some. On the other hand many changeset comments may not even be read and some consider it a waste of time to do something that few if any will ever read and would rather use the time to improve the map data. See Good changeset comments for best practices.

The distinction between note and comment is that a note is generally used on nodes/ways/relations to describe real-world things like "the busstop is actually here but the signpost was knocked down in september 2009", whereas a comment is used on changesets.

See Also

  • note=* - for adding notes to yourself and your fellow mappers.
  • description=* - for adding text that might be viewable to the end user.

Guidance for developers

Especially with respect to changesets:

  • Comment tags shouldn't be automatically generated. If a data-consuming project wishes automated data, it can calculate it itself.
  • Comment tags are not mandatory - e.g. perhaps an editor's workflow doesn't suit adding comments (c.f. Potlatch (v1.x) live mode). However, meaningful changeset comments are very useful, so it is a good idea for editing tools to make it easy for mappers to add them. If your software makes the adding of comments mandatory, you may find that some mappers react in a negative way and enter "garbage" comments.
  • Comment tags should be available in the editor if the user wants to use them.