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

Docs language edit - Part 1 #830

Merged
merged 1 commit into from
May 22, 2024
Merged

Docs language edit - Part 1 #830

merged 1 commit into from
May 22, 2024

Conversation

yuxizama
Copy link
Contributor

I've rephrased some sentences to increase the readability. Please check to ensure that my modification does not alter the technical implications.
Feedback is welcomed!

@cla-bot cla-bot bot added the cla-signed label May 15, 2024
@yuxizama
Copy link
Contributor Author

One question regarding the capitalization of the "compiler" in quick start:
fhe.Compiler
compiler.compile
Are they on purpose?

@bcm-at-zama
Copy link
Contributor

when it's code, yes most of the capitalization is not chosen by the doc writter, but by some rules or filenames in the langage. Could you tell me precise in which file and place you see that, please?

yuxizama
yuxizama commented May 16, 2024
View reviewed changes
Copy link
Contributor Author

@yuxizama yuxizama left a comment

Choose a reason for hiding this comment

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

I marked the inconsistant capitalizations of "compiler" and "circuit.
Could you verify if they are correct?

docs/get-started/quick_start.md Show resolved Hide resolved
docs/get-started/quick_start.md Show resolved Hide resolved
docs/get-started/quick_start.md Outdated Show resolved Hide resolved
docs/get-started/quick_start.md Outdated Show resolved Hide resolved
docs/get-started/quick_start.md Outdated Show resolved Hide resolved
@bcm-at-zama
Copy link
Contributor

Sorry @yuxizama I've a look early next week

bcm-at-zama
bcm-at-zama requested changes May 21, 2024
View reviewed changes
Copy link
Contributor

@bcm-at-zama bcm-at-zama left a comment

Choose a reason for hiding this comment

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

Thx @yuxizama . Some proposed changes.

@yuxizama
Copy link
Contributor Author

@bcm-at-zama
Thanks for the review, I've addressed your comments in the latest commits. You can have a look.
Thanks!

bcm-at-zama
bcm-at-zama requested changes May 22, 2024
View reviewed changes
Copy link
Contributor

@bcm-at-zama bcm-at-zama left a comment

Choose a reason for hiding this comment

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

Minor typo please

docs/get-started/compatibility.md Outdated Show resolved Hide resolved
@yuxizama yuxizama requested a review from bcm-at-zama May 22, 2024 12:53
bcm-at-zama
bcm-at-zama approved these changes May 22, 2024
View reviewed changes
Copy link
Contributor

@bcm-at-zama bcm-at-zama left a comment

Choose a reason for hiding this comment

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

Thx!

@bcm-at-zama
Copy link
Contributor

@BourgerieQuentin : we don't authorize squash and merge in Concrete? here, it would be useful, we're not going to ask Yuxi to squash locally on her terminal

@bcm-at-zama
Copy link
Contributor

@yuxizama will squash!

@bcm-at-zama bcm-at-zama merged commit 0157734 into main May 22, 2024
25 checks passed
@yuxizama yuxizama deleted the docs-language-edit branch May 22, 2024 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bcm-at-zama bcm-at-zama bcm-at-zama approved these changes

@BourgerieQuentin BourgerieQuentin Awaiting requested review from BourgerieQuentin

Assignees
No one assigned
Labels
cla-signed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@yuxizama @bcm-at-zama