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 #608

Open
wants to merge 17 commits into
base: develop
Choose a base branch
from
Open

Conversation

Krish-bhardwaj
Copy link

issue number #607

Checklist

  • My branch is up-to-date with upstream/develop branch.
  • Everything works and tested for Python 3.6.0 and above.

Current behaviour

less reference and some grammatical error in readme file

New expected behaviour

fixed issue

Change logs

can see my commit

@Krish-bhardwaj
Copy link
Author

Hi maintainers , i am new to open source contribution , requested to merge my PR

@Mec-iS
Copy link
Contributor

Mec-iS commented Jan 27, 2022

hydrus shall be alway lowercase

@Mec-iS
Copy link
Contributor

Mec-iS commented Jan 27, 2022

please try to run the server in local and see if there is something useful you can add to the document, at this point there are only minor changes in this PR.

@Krish-bhardwaj
Copy link
Author

Ok

@Krish-bhardwaj
Copy link
Author

Hi @Mec-iS i have done some more changes in the doc please review it. Requested to merge the PR.

@Krish-bhardwaj
Copy link
Author

Hi @Mec-iS why has this test failed ! can you explain me .

@Mec-iS
Copy link
Contributor

Mec-iS commented Jan 29, 2022

you can see the full Travis log at https://app.travis-ci.com/github/HTTP-APIs/hydrus/jobs/557575062

nice try but it is still minor changes.

Conventions:

  • correct spell is "Hydra" for the framework
  • correct spell is "hydrus" for the server

@Krish-bhardwaj
Copy link
Author

you can see the full Travis log at https://app.travis-ci.com/github/HTTP-APIs/hydrus/jobs/557575062

nice try but it is still minor changes.

Conventions:

  • correct spell is "Hydra" for the framework
  • correct spell is "hydrus" for the server

can u explain me this error i am not able to figure it out , i have just changed / added new reference

@Krish-bhardwaj
Copy link
Author

Hi @Mec-iS i have updated the Doc/wiki/images they were not clear and the updated version is better , requested to merge this pr or suggest some more changes

@Mec-iS
Copy link
Contributor

Mec-iS commented Jan 29, 2022

Conventions:
correct spell is "Hydra" for the framework
correct spell is "hydrus" for the server

this is still not implemented.

Also you have to rebase this PR to the develop branch

@Krish-bhardwaj
Copy link
Author

Conventions:
correct spell is "Hydra" for the framework
correct spell is "hydrus" for the server

this is still not implemented.

Also you have to rebase this PR to the develop branch

ok ill look into it

@Krish-bhardwaj
Copy link
Author

Conventions:
correct spell is "Hydra" for the framework
correct spell is "hydrus" for the server

this is still not implemented.

Also you have to rebase this PR to the develop branch

my branch is already on develop
image

@Mec-iS
Copy link
Contributor

Mec-iS commented Jan 29, 2022

Also you have to rebase this PR to the develop branch

my branch is already on develop
image

yes but your develop is not up to date with the remote one, so you have to pull or rebase. You need to be familiar with git and Github.

@Krish-bhardwaj
Copy link
Author

Also you have to rebase this PR to the develop branch

my branch is already on develop
image

yes but your develop is not up to date with the remote one, so you have to pull or rebase. You need to be familiar with git and Github.

now can you verify is my branch up to date ! , i will correct hydra and hydrus typo

@Krish-bhardwaj
Copy link
Author

hi @Mec-iS i have done some more contribution , i have one doubt when we run help(hydrus) it is not showing all the comments why ?
image

Copy link
Member

@farazkhanfk7 farazkhanfk7 left a comment

Choose a reason for hiding this comment

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

  1. hydrus is small-case
  2. I don't think we need images in hydrus repo
  3. You have converted the docstrings in python files to comments. Docstrings and comments are not the same thing. You can see the memo in the docstrings easily by running "help" function. Docstrings are helpful to explain a detailed description of function, class or module

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.

4 participants