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

Update README.md #11

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,20 @@ Finally save the changes:
```python
T.save('translations')
```
## Adding comments
You can add comments to the original language by using a comment marker.
This can be useful if you want to translate a specific section.

Initialise the Translator with the marker you want to use (default is None):
```python
T = Translator('translations', comment_marker="##")
```
Use it like this:
```python
msg = T("Beginner's Guide to Python## Title chapter 1")
```
If there is no translation available it will show only the part before the marker.
```python
>>> print(msg)
Beginner's Guide to Python
```