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.

Sign up for GitHub

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

Jump to bottom

Fix grammar and phrasing #223

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix grammar and phrasing #223

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,14 @@ Introduction
[![Backers on Open Collective](https://opencollective.com/redbaron/backers/badge.svg)](#backers)
[![Sponsors on Open Collective](https://opencollective.com/redbaron/sponsors/badge.svg)](#sponsors)

RedBaron is a python library and tool powerful enough to be used into IPython
solely that intent to make the process of **writing code that modify source
code** as easy and as simple as possible. That include writing custom
"RedBaron is a Python library and tool powerful enough to be used in IPython.
It aims to make the process of writing code that modifies source code as easy and simple as possible." That includes writing custom
Comment on lines +8 to +9
Copy link
Author

@ikamensh ikamensh Aug 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"RedBaron is a Python library and tool powerful enough to be used in IPython.
It aims to make the process of writing code that modifies source code as easy and simple as possible." That includes writing custom
"RedBaron is a Python library designed to be used with IPython.
It aims to make the process of writing code that modifies source code as easy and simple as possible." That includes writing custom

This was trying to be as close to original as possible. At the same time it now seems that first sentence tells nothing in particular except association with IPython. Is RedBaron designed to work best with IPython?

refactoring, generic refactoring, tools, IDE or directly modifying you source
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is the difference of custom and generic refactoring?

code into IPython with a higher and more powerful abstraction than the
advanced texts modification tools that you find in advanced text editors and
IDE.

RedBaron guaranteed you that **it will only modify your code where you ask him
RedBaron guarantees you that **it will only modify your code where you ask him
to**. To achieve this, it is based on [Baron](https://github.com/PyCQA/baron)
a lossless [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree) for
Python that guarantees the operation <code>ast_to_code(code_to_ast(source_code)) == source_code</code>.
Expand Down