ENH: add finish milestone option. #655
Conversation
Codecov Report
@@ Coverage Diff @@
## master #655 +/- ##
==========================================
- Coverage 68.12% 68.10% -0.03%
==========================================
Files 67 67
Lines 6705 6718 +13
==========================================
+ Hits 4568 4575 +7
- Misses 2137 2143 +6
Continue to review full report at Codecov.
|
Let's make it not required. |
|
One more thing. The a_projecta/u_projecta seems to have changed now that it dumps to .yaml instead of .yml which is what we have been using in the group databases. this is breaking everything now unfortunately. Is that a change that you might have made as a part of this checklist work? I need it fixed asap.... |
its really weird. I compared, for example, a_expense and this is working fine (reads |
|
Hi Simon, if we want the "--finish <report_summary>" to be optional, we need to have two separate options, one to tell the program that we are doing |
|
The How would I see this bug? i.e. how to reproduce to see it is dumping to |
|
@sbillinge ready for review and merge. As we discussed, |
There was a problem hiding this comment.
looks good.
- I think it would be good to have a one-line print statement that says the name of the milestone, the prum and says has been finished.
- need a news
- it would be more useful yet if we could specify slices of indices. Not sure how to do that, but it would make it much better. e.g., 1-5 would close 1,2,3,4,5 and 1-5,7 would close 1,2,3,4,5,7. Don't spend a lot of time on writing a parser for this, but can we give an int or a list and use the slicing in python lists? so user has to type [0:4,6] for the above behavior?
|
Thanks Simon. I updated. for "adding a news", do you mean write some news words when "--finish"? I think we have to create another argument like |
|
news is a rever thing. It is used in the changelog when the code is release
saying what has been done. in regolith/news open TEMPLATE.rst, then save
it as <branchname>.rst and edit it to say what you did (in this case, added
functionality).
…On Tue, Dec 8, 2020 at 3:01 AM longyang ***@***.***> wrote:
Thanks Simon. I updated. for "adding a news", do you mean write some news
words when "--finish"? I think we have to create another argument like
--news to do so. And, I thought we want a quick way to finish milestones,
but if we request people to add a news, we cannot finish a list of
milestones anymore, am I understanding correctly?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#655 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABAOWUOSMV62ECJKV7JABWLSTXMNNANCNFSM4UHCO7EA>
.
--
Simon Billinge
Professor, Columbia University
Physicist, Brookhaven National Laboratory
|
|
Got it. Done. |
news/helper_f_milestone.rst
Outdated
| @@ -0,0 +1,13 @@ | |||
| **Added:** None | |||
news/helper_f_milestone.rst
Outdated
| @@ -0,0 +1,13 @@ | |||
| **Added:** None | |||
| * A finish argument to finish milestone and record the end datetime. | |||
| * A list of indexes can be specified for the u_milestone helper. | |||
There was a problem hiding this comment.
plural of index is indices
| help="Index of the item in the enumerated list to update. " | ||
| "If multiple indexes, separate by space", | ||
| type = int) | ||
| "Please enter in the format of `2,5,7` or `3-7`", |
There was a problem hiding this comment.
this isn't quite clear. do you need left-leaning quotes or not? No spaces in the list? I guess you are going to parse as as string? Can I leave a single integer or do I have to do 2 for just closing one milestone? Preferrable would be if it is an int it will do just one in that case
|
thanks @dragonyanglong this looks great. I will test! |
This PR closes #624
@sbillinge please review and merge.
BTW, how do you want the string argument to be put into
report_summary? Currently I make it force to be an input, or we can change it to optional.