Rename ksAppendKey to ksInsert

[lawli3t]

[markus2330]

How do we call ksAppend then?

[stale[bot]]

I mark this issue stale as it did not have any activity for one year. I'll close it in two weeks if no further activity occurs. If you want it to be alive again, ping the issue by writing a message here or create a new issue with the remainder of this issue. Thank you for your contributions :sparkling_heart:

[markus2330]

@lawli3t there is still an open question

[lawli3t]

I would have thought ksAppend just keeps its name

[markus2330]

Sounds inconsistent to me as they are basically doing the same thing (either with a Key or a KeySet)?

[kodebach]

How about ksInsert and ksInsertAll?

I think the main issue is that "append" suggests adding to the end, which is not at all what happens.

[flo91]

This issue is part of the issue #4411 which is tagged as project2022w. Maybe we can also offer this issue as a separate FLOSS task.

[kodebach]

In general, people should prefer different issues over these simple rename/API change issues, because the renaming/API changes can (hopefully) be done with the tool I'm developing for my thesis.

If people still choose issues like this one, it would be nice if they could record how much time they spent. Then I could use that data as a comparison in my thesis. (I can always just run my tool on an old commit before the change to get some results.)

cc @markus2330

[markus2330]

I agree that the renaming parts are better done by the @kodebach's tool.

it would be nice if they could record how much time they spent.

@kodebach If you really want to do that, you need to precisely clarify what they should do (how to measure the time etc. according to your methodology) I can ask in the course who wants to do that. Then we should also carefully select which renaming (in case of doubt randomly. Letting the people select is not a good idea, as they will probably bias to simple renaming tasks).

[kodebach]

I'll see if I can come up with some concrete instructions. But this comparison "manual vs. tool" (intentionally) isn't really required to answer my research questions. So I would have just added the comparison as some examples of how the tool can help make things easier, not as a rigorous scientific evaluation.

[markus2330]

Yes but even as an example (case study) it must be clear what the people did. Maybe even more important than instructions is a small questionnaire which gives insights which tooling they used (e.g. an IDE, sed, ...).

Anyway, I will tell the students that this is an option. Can you create an explicit issue for the renaming/removal you would like to be done or can it be any renaming/removal?

[kodebach]

In general any renaming should be fine. Removal functions depends on what the replacement is. If there is a straight-forward replacement then it should also be fine, e.g. keyGetMeta -> ksLookupByName (keyMeta) + add meta:/ prefix is missing. If the replacement is more complex and requires looking at the surrounding code, then I'd need to take a look to decide whether it would be useful for my thesis.

I can provide a list, but I'm not sure when I'll find time to do this. It's probably easier and quicker, if people just ask me for a specific API change they want to do.

[github-actions[bot]]

I mark this stale as it did not have any activity for one year. I'll close it in two weeks if no further activity occurs. If you want it to be alive again, ping by writing a message here or create a new issue with the remainder of this issue. Thank you for your contributions :sparkling_heart:

[github-actions[bot]]

I closed this now because it has been inactive for more than one year. If I closed it by mistake, please do not hesitate to reopen it or create a new issue with the remainder of this issue. Thank you for your contributions :sparkling_heart: