taskReproducible paper template - Tasks: task #15732, Minor typos/language...

 
 

You are not allowed to post comments on this tracker with your current authentication level.

task #15732: Minor typos/language corrections/clarifications

Submitted by:  Boud Roukema <boud>
Submitted on:  Mon 20 Jul 2020 05:55:51 PM UTC  
 
Should Start On:  Mon 20 Jul 2020 12:00:00 AM UTC Should be Finished on:  Mon 20 Jul 2020 12:00:00 AM UTC
Category:  None Priority:  5 - Normal
Status:  None Privacy:  Public
Percent Complete:  0% Assigned to:  None
Open/Closed:  Open Effort:  0.00

Tue 21 Jul 2020 08:41:39 PM UTC, comment #4: 

comment #3:

> Thanks Boud, good (and useful!) point ;-)! It is now in Maneage under Commit 2fadf4ba6f.
>
> I just removed the '$$(pwd)' part because the '$$unchecked' file is not in project's top directory. It is in the same directory as the ultimate target ('$@'). After all, it was defined like this:
>

> unchecked=$@.unchecked

>
> So its in the same place that the ultimate target should be, but is just appended with an '.unchecked' suffix.


I see that my branch of maneage has already diverged a bit - in my case the '$$(pwd)' is necessary. :)  A merge or commit proposal will have to be left to later...

> By the way, it would also be great if instead of `, you could use a single-quote/apastrophe (') to mark code components in commit messages (or comments). This is recommended by the GNU Coding standards and would help in making the code more consistent ;-).


I was mostly using the backtick because github and bitbucket use something like markdown, in which the backtick is useful for strings of code. That's not an ethical reason, it's a practical reason. Savannah uses a different form of markup, so in principle it's a good idea to switch here. Also, I see that codeberg, running gitea , does not seem to pass git commit comments through any sort of font convertor like markdown or rich markup.

Following https://www.gnu.org/prep/standards/html_node/Quote-Characters.html#Quote-Characters I'm happy to try either apostrophes or double quotes.

I included a full quote of your previous comment, but replaced '-verbatm-' by '-verbatim-' in order to properly close the verbatim section. It turned out that your verbatim section was kept secret from the html rendered version because of the typo... :)

Boud Roukema <boud>
Project Member
Tue 21 Jul 2020 04:43:17 PM UTC, comment #3: 

Thanks Boud, good (and useful!) point ;-)! It is now in Maneage under Commit 2fadf4ba6f.

I just removed the '$$(pwd)' part because the '$$unchecked' file is not in project's top directory. It is in the same directory as the ultimate target ('$@'). After all, it was defined like this:

Mohammad Akhlaghi <makhlaghi>
Project Administrator
Tue 21 Jul 2020 04:22:30 PM UTC, comment #2: 

Here's a one-line commit to clarify to the user how s/he might want to solve a failed checksum for downloads:

https://codeberg.org/boud/maneage_dev/commit/9226955b70dd7476aa21c7b821dbd160ecd73791

Boud Roukema <boud>
Project Member
Mon 20 Jul 2020 09:42:04 PM UTC, comment #1: 

Thanks Boud, I agree, it would be good to have this task for small  commits that would just crowd the bug/task lists!

It has been implemented in Commit 2bfe5e16a0ba. As you see, I just built upon your change and moved the part on later updating the metadata in the "Fill basic info" item, and made a new item in the end about uploading new versions.

Mohammad Akhlaghi <makhlaghi>
Project Administrator
Mon 20 Jul 2020 05:55:51 PM UTC, original submission:  

I propose that this be like on gnuastro(?) - a permanent task for posting pull requests for small minor commits.

Here I propose commit 0529684b0c, with text changes in README-hacking.md . The most important change is to clarify to the user (who may not yet have used Zenodo) that reserving a Zenodo DOI and saving is an intermediate step that still allows changes. Only "publish" freezes the content of the research package.

https://codeberg.org/boud/maneage_dev/commit/0529684b0c3db7472bb257c690c143bddf8560e3

Boud Roukema <boud>
Project Member

 

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by makhlaghi (Posted a comment)
  • -email is unavailable- added by boud (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

     

     

    No changes have been made to this item

    Back to the top


    Powered by Savane 3.5