Consider `@source` #170

Closed
pascalduez opened this Issue Aug 18, 2014 · 8 comments

Comments

Projects
None yet
3 participants
@pascalduez
Member

pascalduez commented Aug 18, 2014

Observations

Additionally to @author I kinda like to point to the source as well. Example
Might comes in handy if you later want to check whether the snippet has been updated or not, or provide more context.

Suggestion

/**
 * @source <link>
 * @source title <link>
 */

@pascalduez pascalduez added this to the 1.4 milestone Aug 18, 2014

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Aug 18, 2014

Member

Wouldn't @link suffice?

Member

HugoGiraudel commented Aug 18, 2014

Wouldn't @link suffice?

@pascalduez

This comment has been minimized.

Show comment
Hide comment
@pascalduez

pascalduez Aug 18, 2014

Member

Wouldn't @link suffice?

Well, yeah maybe. Did not really think of it.

I would say that @source is carrying more "semantic" and make the crediting intention clearer, while @link is more about providing additional information.

Member

pascalduez commented Aug 18, 2014

Wouldn't @link suffice?

Well, yeah maybe. Did not really think of it.

I would say that @source is carrying more "semantic" and make the crediting intention clearer, while @link is more about providing additional information.

@FWeinb

This comment has been minimized.

Show comment
Hide comment
@FWeinb

FWeinb Aug 19, 2014

Member

We could add an alias of source to the link annotation?

Member

FWeinb commented Aug 19, 2014

We could add an alias of source to the link annotation?

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Aug 19, 2014

Member

Sounds like the simplest solution. Let's do that.

Member

HugoGiraudel commented Aug 19, 2014

Sounds like the simplest solution. Let's do that.

@pascalduez

This comment has been minimized.

Show comment
Hide comment
@pascalduez

pascalduez Aug 19, 2014

Member

Perfect, yes.

Member

pascalduez commented Aug 19, 2014

Perfect, yes.

@FWeinb FWeinb self-assigned this Aug 19, 2014

FWeinb added a commit that referenced this issue Aug 19, 2014

@FWeinb FWeinb closed this Aug 19, 2014

@pascalduez

This comment has been minimized.

Show comment
Hide comment
@pascalduez

pascalduez Aug 19, 2014

Member

One issue I see though. An alias will not create a dedicated key on the data object ?
In this case @source is going to be on item.links ?
So not possible to differentiate them at the theme level.

Member

pascalduez commented Aug 19, 2014

One issue I see though. An alias will not create a dedicated key on the data object ?
In this case @source is going to be on item.links ?
So not possible to differentiate them at the theme level.

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Aug 19, 2014

Member

Sounds good enough.

Member

HugoGiraudel commented Aug 19, 2014

Sounds good enough.

@FWeinb

This comment has been minimized.

Show comment
Hide comment
@FWeinb

FWeinb Aug 19, 2014

Member

Yeah, should be enough.

Member

FWeinb commented Aug 19, 2014

Yeah, should be enough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment