Skip to content

Added usage info in README#25

Open
adil-uddin wants to merge 2 commits intodimagi:masterfrom
adil-uddin:docs/readme_usage
Open

Added usage info in README#25
adil-uddin wants to merge 2 commits intodimagi:masterfrom
adil-uddin:docs/readme_usage

Conversation

@adil-uddin
Copy link
Contributor

No description provided.

@adil-uddin
Copy link
Contributor Author

@mkangia updated README please check and let me know if I missed anything

* This tool fixes markdown issues with
* Headings (level 1 to 6),
* Ordered Lists
* Unordered Lists
Copy link
Contributor

Choose a reason for hiding this comment

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

@akshita-sh can you please review this?

Copy link
Contributor

Choose a reason for hiding this comment

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

Choose a reason for hiding this comment

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

We should add Untranslated text in the translated column as an addition to possible fixes. https://dimagi-dev.atlassian.net/browse/ICDS-1709.

Though I haven't yet used the script, app team members who have, have more suggestions on improvements which we plan to take up later. I think once the use of this script is much more familiar in the app, the corresponding confluence page can have examples as well in the documentation. Right now the documentation is very brief. For now, though it looks fine.

https://github.com/dimagi/CommcareTranslationChecker/releases


#Usage:

Choose a reason for hiding this comment

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

Missing space after #

## Suggestions on possible fixes
* Output Tag mismatches
* If there is any output tag in translated text not present in base text, removes the output tags in translated text.
* If there are two output tags and they are out of order in translated text, the tool swaps their positions if ignore order flag is not set

Choose a reason for hiding this comment

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

Is the ignore order flag set by default on the feature incorporated in HQ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments