Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FAQ Entry on "How do I remove an element from the LST?" #290

Closed
timtebeek opened this issue Jun 23, 2024 · 0 comments
Closed

FAQ Entry on "How do I remove an element from the LST?" #290

timtebeek opened this issue Jun 23, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@timtebeek
Copy link
Contributor

As suggested on Slack.

My degree is not in education nor writing, i can only speak from my personal learning curve experience in the last three weeks. The docs are written very well, though it's feels like a lot to digest in the beginning.
I kept thinking it may be good to have a beginner's FAQ, with simple straight Q & A, like in this case: „How do i remove an element from the LST“. Simple questions, short answers (where possible), with a link "Read more in {topic} here".

We have a hint as to removing elements on the best practices page
image

But removing an element is so common that it might make sense to call that out explicitly in the FAQ, and from there link to where folks can read more. Perhaps also covering some of the nuance as explained here.

I meant if it's safe to remove in that particular spot, which can be surprising at times
see for instance this very simple recipe
we run that as part of our recipe best practices applied to every PR
that quite bluntly removed any print statements, but at times results in odd auotmated code suggestions, as seen here
in this case I see no need to fix that particular recipe just yet: it mostly works ok, and is a good trigger to start a discussion on PRs, but in other cases you might want to inspect what else is on the stack

@timtebeek timtebeek added the enhancement New feature or request label Jun 23, 2024
@timtebeek timtebeek added the documentation Improvements or additions to documentation label Jun 23, 2024
@timtebeek timtebeek moved this to Backlog in OpenRewrite Jun 23, 2024
@github-project-automation github-project-automation bot moved this from Backlog to Done in OpenRewrite Aug 5, 2024
@mike-solomon mike-solomon self-assigned this Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Archived in project
Development

No branches or pull requests

2 participants