Parameter names about geomtextpath HOT 7 CLOSED

Hi Teun. I'm glad you brought this up. I think now is a good time to think about renaming. I had previously got into the habit of putting periods before functions I didn't want to export, but this isn't really helpful within the roxygen ecosystem, and sometimes proves an annoyance, so we should probably remove the periods.

For the parameter names you mentioned, my thoughts are

• include_line -> text_only (needs flipped logically)
• cut_path -> gap (short and doesn't need flipped logically)
• flip_inverted -> upright
• offset -> I think I'd keep this but maybe change the variable name to something else, like offset_paths
• keep_straight -> straight

from geomtextpath.

putting periods before functions

I think this works for functions that you want to export but not expose. I think the typical way to indicate a function is internal is to declare the following in the roxygen comments:

#' @keywords internal

cut_path -> gap (short and doesn't need flipped logically)

This is nice and better than what I could come up with.

I think now is a good time to think about renaming

There are indeed some function in the package that have changed meaning over the course of development. I think .get_path_points() doesn't really get points on a path but it places the text, so maybe a better name might be place_text()? Perhaps .get_surrounding_lines() could be make_gap()? Any functions you'd like to mark for renaming?

from geomtextpath.

I don't really see the value of roxygen comments for non-exported functions. If no docs are built, then standard comments to help with maintenance and debugging should be adequate. It's reasonable to preface them with roxygen tags to help package building of course.

from geomtextpath.

I agree with your suggestions for .get_path_points and .get_surrounding_lines. I had wondered if the file name geometry_helpers.R had become a bit inaccurate too, but I can't really think of anything more appropriate at the moment.

from geomtextpath.

Yes good point. I think splitting them out to text_placement.R and path_handling.R or something might be better. The path_handling.R file can also get the dedup_path, pathify, prepare_path and .add_path_grob functions.

from geomtextpath.

I'll go and rename some of the parameters according to the suggestions, and maybe split the geometry_helpers.R file.

from geomtextpath.

I think we can close this for now

from geomtextpath.