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 documentation and add initial project configurations #46

Merged
merged 3 commits into from
Jan 22, 2024

Conversation

Himanshu21git
Copy link
Contributor

@Himanshu21git Himanshu21git commented Jan 20, 2024

In this PR,

  • Enhanced documentation and added initial configuration example.
  • Fixed markdown issues in files
  • Fixed typos in the documentation

Test Results:

image

CHANGELOG.md Outdated
@@ -2,28 +2,28 @@

## v0.10.1

* Fix a bug with `nil` decimals that happens on Ecto 3.11+.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you please remove these whitespace changes? They're not necessary, and in addition I prefer the spaces there 🙃

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

Comment on lines 28 to 38

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
Copy link
Collaborator

Choose a reason for hiding this comment

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

These are unnecessary changes, could you revert them?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

README.md Outdated
Comment on lines 35 to 37
use Ecto.Repo,
otp_app: :my_app,
adapter: Exandra
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you revert this change, as it's unnecessary?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

README.md Outdated
@@ -61,7 +84,7 @@ field :features, :map

you can pass the field as an Elixir map when setting it, and Exandra will convert it to a map
on the way from the database. Because Exandra uses JSON for this, you'll have to pay attention
to things such as atom keys (which can be used when writing, but will be strings when reading)
to things such as atom keys (which can be used when writing but will be strings when reading)
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is an unnecessary change, could you remove it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

README.md Outdated
@@ -133,7 +157,7 @@ defmodule AddUsers do
end
```

> #### Cassandra and Scylla Types {: .info}
> ### Cassandra and Scylla Types {: .info}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you revert this change, as it's subjective?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@Himanshu21git
Copy link
Contributor Author

@whatyouhide I've made the requested revisions and would appreciate your review.

@whatyouhide whatyouhide merged commit 2817824 into vinniefranco:main Jan 22, 2024
@whatyouhide
Copy link
Collaborator

Thank you @Himanshu21git 🙏

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.

2 participants