Monday, March 25, 2024

Beginner-Friendly Issue of the week

Hi everybody,

we're cleaning out the issue tracker. Some things are important, but falling off our list of things we can reasonably manage to do. Some of these things are not actually hard, I think, but need someone who can work with GRC and attack these.

This is one of these issues:

https://github.com/gnuradio/gnuradio/issues/1106, "Deprecate packet synchronizers"

These blocks have been around forever, and I don't even know whether every single one of them still exists. Someone could go through the list and just search for the strings that don't have a file name attached to them and see whether they still exist, and comment on that.

Afterwards, they could go through that list and do:

for each individual block mentioned
  1. add the flags: [deprecated] property to each block's gr-something/grc/something_blockname.block.yml,
  2. Make sure the block still shows up correctly in GRC, but marked as deprecated (orange!)
  3. search the examples whether any existing example uses the block
  4. open a new issue "remove or update example XYZ to not use deprecated block" for each affected example
  5. (equally important) add a remark to the block's wiki page (if it exists) that it's deprecated, in bold, quite at the beginning of each page

while doing this, talking to the people in the #docs Matrix chat room is probably a good idea, they have a good idea of existing examples, and the wiki.


Best regards,
Marcus

No comments:

Post a Comment