Issue909

Title add function for formatting journal paper references
Priority wish Status resolved
Superseder Nosy List jendrik, malte
Assigned To jendrik Keywords
Optional summary

Created on 2019-03-12.20:10:20 by jendrik, last changed by jendrik.

Messages
msg8669 (view) Author: jendrik Date: 2019-03-13.09:03:26
Merged.
msg8668 (view) Author: malte Date: 2019-03-12.22:35:06
Many thanks! Diff looks good to merge.
msg8667 (view) Author: jendrik Date: 2019-03-12.22:15:43
I renamed the functions and the code now uses ostringstream instead of
stringstream in the places you mentioned.
msg8666 (view) Author: malte Date: 2019-03-12.21:58:03
> I suggest to do the renaming separately to keep the diff small.

I don't think it would be hard to review, and if it can be easily avoided, an
issue should not leave the default branch in a broken state. I think a
combination of "format_paper_reference" and "format_journal_article_reference"
is a (mildly) broken interface because it's an inconsistent level of
abstraction. (A journal article reference is a paper reference.)

Regarding the name, "journal article" is a better word in isolation, but
"journal paper" is sufficiently common, and it's good to have parallel names for
parallel functions. Another option would be "format_conference_reference" and
"format_journal_reference". But I'm also fine with your names.
msg8665 (view) Author: jendrik Date: 2019-03-12.21:46:20
I suggest to do the renaming separately to keep the diff small.

Here is a pull request:
https://bitbucket.org/jendrikseipp/downward/pull-requests/130

I called the function "format_journal_article_reference" since "journal article"
yields more results than "journal paper" on Google but am indifferent regarding
the name.
msg8664 (view) Author: malte Date: 2019-03-12.20:12:21
Title sounds good! I would suggest renaming "format_paper_reference" to
"format_conference_paper_reference" at the same time for clarity.
History
Date User Action Args
2019-03-13 09:03:26jendriksetstatus: reviewing -> resolved
messages: + msg8669
2019-03-12 22:35:06maltesetmessages: + msg8668
2019-03-12 22:15:43jendriksetmessages: + msg8667
2019-03-12 21:58:03maltesetmessages: + msg8666
2019-03-12 21:46:20jendriksetstatus: in-progress -> reviewing
messages: + msg8665
2019-03-12 20:12:21maltesetmessages: + msg8664
2019-03-12 20:10:20jendrikcreate