From 2e795ed8aa5ce50807d739bd22db7dfb575bbd08 Mon Sep 17 00:00:00 2001 From: Robert Swain Date: Thu, 18 May 2017 15:57:07 +0200 Subject: [PATCH] mediaapi/storage: Improve GetMediaMetadata description --- .../matrix-org/dendrite/mediaapi/storage/storage.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/github.com/matrix-org/dendrite/mediaapi/storage/storage.go b/src/github.com/matrix-org/dendrite/mediaapi/storage/storage.go index c5d5b68a6..072ec4f8f 100644 --- a/src/github.com/matrix-org/dendrite/mediaapi/storage/storage.go +++ b/src/github.com/matrix-org/dendrite/mediaapi/storage/storage.go @@ -47,7 +47,9 @@ func (d *Database) StoreMediaMetadata(mediaMetadata *types.MediaMetadata) error return d.statements.insertMedia(mediaMetadata) } -// GetMediaMetadata possibly selects the metadata about previously uploaded media from the database. +// GetMediaMetadata returns metadata about media stored on this server. The media could +// have been uploaded to this server or fetched from another server and cached here. +// Returns sql.ErrNoRows if there is no metadata associated with this media. func (d *Database) GetMediaMetadata(mediaID types.MediaID, mediaOrigin gomatrixserverlib.ServerName) (*types.MediaMetadata, error) { return d.statements.selectMedia(mediaID, mediaOrigin) }