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

Improve API documentation #16

Closed

ljvmiranda921 opened this issue Jul 28, 2017 · 1 comment

Labels

documentation help wanted

Owner

ljvmiranda921 commented Jul 28, 2017

Currently the documentation is untouched, and much of the docstrings in the modules are not yet presented. Can you lend us a hand?

ljvmiranda921 added documentation help wanted labels

ljvmiranda921 added this to the First Major Release (v1.0.0) milestone

ljvmiranda921 pushed a commit that referenced this issue


          Updated documentation (#16)

2a4b218

Owner Author

ljvmiranda921 commented Jul 29, 2017

Nah. I can do it.

ljvmiranda921 closed this as completed

ljvmiranda921 pushed a commit that referenced this issue


          Updated documentation (#16)

8bf100a

ljvmiranda921 pushed a commit that referenced this issue


          Updated Python versions in CONTRIBUTING.rst (#16)

108c50a

ljvmiranda921 pushed a commit that referenced this issue


          Fixed documentation error (#16)

8fbb0d5

ljvmiranda921 pushed a commit that referenced this issue


          Removed custom theme (#16)

05c64c7

ljvmiranda921 pushed a commit that referenced this issue


          Updated documentation (#16)

119e6af

ljvmiranda921 pushed a commit that referenced this issue


          Added examples in docstrings (#16)

190b5de

ljvmiranda921 pushed a commit that referenced this issue


          Updated Documentation (#16)

e8f7cd0

ljvmiranda921 pushed a commit that referenced this issue


          Updated RTD sidebar look (#16)

b9afcf5

ljvmiranda921 pushed a commit that referenced this issue


          Updated Introduction (#16)

e0db74f

ljvmiranda921 pushed a commit that referenced this issue


          Added Introduction (#16)

7b1e40a

ljvmiranda921 pushed a commit that referenced this issue


          Added new example, training a neural network with PSO (#16)

62b4985

ljvmiranda921 pushed a commit that referenced this issue


          Fixed some bullet points (#16)

40e2fc3

ljvmiranda921 pushed a commit that referenced this issue


          Updated badges (#16)

a7aff90

ljvmiranda921 pushed a commit that referenced this issue


          Improved documentation (#16)

b790f32

This is a massive documentation update in order to make the
ReadTheDocs website as appealing it should be. In summary, the
following were undertaken:
  - Small patch fix for importing modules
  - Small modification in console_utils for console output
  - Modified ReadTheDocs' sidebar theme with an overriding css file.
  - Added a use-case example on Basic Optimization
  - Updated docstrings for most module implementations to make
    it look nice in the API documentation.

Even though most of these updates occured at different files,
they were all done for the sole purpose of improving documentation
in ReadTheDocs and introducing an API documentation at the end.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update example on training a neural network (#16)

e65843e

This is an update to the previous commit regarding the documentation.
A use-case example for training a neural network is now implemented
as a Jupyter Notebook and as an .reST file in ReadTheDocs.

Also, a small stylistic change was done in asserting membership, if
we are to check if a certain key is in a dictionary, we now do the
following

  >>> if <set-of-keys> not in <required-set-of-keys>

Before, we are doing a `if not <set-of-keys> in`, which is
grammatically awkward. The new call sounds more natural and idiomatic.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Fixed documentation error (#16)

This is a small patch to fix the examples in the docstrings.
Moreso, an index was also added to facilitate easier documentation.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Improved documentation (#16)

42d08e6

This is a massive documentation update in order to make the
ReadTheDocs website as appealing it should be. In summary, the
following were undertaken:
  - Small patch fix for importing modules
  - Small modification in console_utils for console output
  - Modified ReadTheDocs' sidebar theme with an overriding css file.
  - Added a use-case example on Basic Optimization
  - Updated docstrings for most module implementations to make
    it look nice in the API documentation.

Even though most of these updates occured at different files,
they were all done for the sole purpose of improving documentation
in ReadTheDocs and introducing an API documentation at the end.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update example on training a neural network (#16)

45c0d1e

This is an update to the previous commit regarding the documentation.
A use-case example for training a neural network is now implemented
as a Jupyter Notebook and as an .reST file in ReadTheDocs.

Also, a small stylistic change was done in asserting membership, if
we are to check if a certain key is in a dictionary, we now do the
following

  >>> if <set-of-keys> not in <required-set-of-keys>

Before, we are doing a `if not <set-of-keys> in`, which is
grammatically awkward. The new call sounds more natural and idiomatic.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update Python versions in CONTRIBUTING.rst (#16)

722dfb0

Unless the world really needs to, this package will
only support Python 3.X versions.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Fixed documentation error (#16)

b4b90f4

This is a small patch to fix the examples in the docstrings.
Moreso, an index was also added to facilitate easier documentation.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Improved documentation (#16)

1540b22

This is a massive documentation update in order to make the
ReadTheDocs website as appealing it should be. In summary, the
following were undertaken:
  - Small patch fix for importing modules
  - Small modification in console_utils for console output
  - Modified ReadTheDocs' sidebar theme with an overriding css file.
  - Added a use-case example on Basic Optimization
  - Updated docstrings for most module implementations to make
    it look nice in the API documentation.

Even though most of these updates occured at different files,
they were all done for the sole purpose of improving documentation
in ReadTheDocs and introducing an API documentation at the end.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update example on training a neural network (#16)

53bac3e

This is an update to the previous commit regarding the documentation.
A use-case example for training a neural network is now implemented
as a Jupyter Notebook and as an .reST file in ReadTheDocs.

Also, a small stylistic change was done in asserting membership, if
we are to check if a certain key is in a dictionary, we now do the
following

  >>> if <set-of-keys> not in <required-set-of-keys>

Before, we are doing a `if not <set-of-keys> in`, which is
grammatically awkward. The new call sounds more natural and idiomatic.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update Python versions in CONTRIBUTING.rst (#16)

aa948bc

Unless the world really needs to, this package will
only support Python 3.X versions.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Fixed documentation error (#16)

7ffedd4

This is a small patch to fix the examples in the docstrings.
Moreso, an index was also added to facilitate easier documentation.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Improved documentation (#16)

5cd02ea

This is a massive documentation update in order to make the
ReadTheDocs website as appealing it should be. In summary, the
following were undertaken:
  - Small patch fix for importing modules
  - Small modification in console_utils for console output
  - Modified ReadTheDocs' sidebar theme with an overriding css file.
  - Added a use-case example on Basic Optimization
  - Updated docstrings for most module implementations to make
    it look nice in the API documentation.

Even though most of these updates occured at different files,
they were all done for the sole purpose of improving documentation
in ReadTheDocs and introducing an API documentation at the end.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update example on training a neural network (#16)

02e1fd9

This is an update to the previous commit regarding the documentation.
A use-case example for training a neural network is now implemented
as a Jupyter Notebook and as an .reST file in ReadTheDocs.

Also, a small stylistic change was done in asserting membership, if
we are to check if a certain key is in a dictionary, we now do the
following

  >>> if <set-of-keys> not in <required-set-of-keys>

Before, we are doing a `if not <set-of-keys> in`, which is
grammatically awkward. The new call sounds more natural and idiomatic.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update Python versions in CONTRIBUTING.rst (#16)

ffc4ed9

Unless the world really needs to, this package will
only support Python 3.X versions.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Fixed documentation error (#16)

dd0d384

This is a small patch to fix the examples in the docstrings.
Moreso, an index was also added to facilitate easier documentation.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Improved documentation (#16)

a50c71f

This is a massive documentation update in order to make the
ReadTheDocs website as appealing it should be. In summary, the
following were undertaken:
  - Small patch fix for importing modules
  - Small modification in console_utils for console output
  - Modified ReadTheDocs' sidebar theme with an overriding css file.
  - Added a use-case example on Basic Optimization
  - Updated docstrings for most module implementations to make
    it look nice in the API documentation.

Even though most of these updates occured at different files,
they were all done for the sole purpose of improving documentation
in ReadTheDocs and introducing an API documentation at the end.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update example on training a neural network (#16)

This is an update to the previous commit regarding the documentation.
A use-case example for training a neural network is now implemented
as a Jupyter Notebook and as an .reST file in ReadTheDocs.

Also, a small stylistic change was done in asserting membership, if
we are to check if a certain key is in a dictionary, we now do the
following

  >>> if <set-of-keys> not in <required-set-of-keys>

Before, we are doing a `if not <set-of-keys> in`, which is
grammatically awkward. The new call sounds more natural and idiomatic.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update Python versions in CONTRIBUTING.rst (#16)

a1411d0

Unless the world really needs to, this package will
only support Python 3.X versions.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Fix documentation error (#16)

d56cb1b

This is a small patch to fix the examples in the docstrings.
Moreso, an index was also added to facilitate easier documentation.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Improve documentation (#16)

cdfbb00

This is a massive documentation update in order to make the
ReadTheDocs website as appealing it should be. In summary, the
following were undertaken:
  - Small patch fix for importing modules
  - Small modification in console_utils for console output
  - Modified ReadTheDocs' sidebar theme with an overriding css file.
  - Added a use-case example on Basic Optimization
  - Updated docstrings for most module implementations to make
    it look nice in the API documentation.

Even though most of these updates occured at different files,
they were all done for the sole purpose of improving documentation
in ReadTheDocs and introducing an API documentation at the end.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update example on training a neural network (#16)

a1300ae

This is an update to the previous commit regarding the documentation.
A use-case example for training a neural network is now implemented
as a Jupyter Notebook and as an .reST file in ReadTheDocs.

Also, a small stylistic change was done in asserting membership, if
we are to check if a certain key is in a dictionary, we now do the
following

  >>> if <set-of-keys> not in <required-set-of-keys>

Before, we are doing a `if not <set-of-keys> in`, which is
grammatically awkward. The new call sounds more natural and idiomatic.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update Python versions in CONTRIBUTING.rst (#16)

8146a34

Unless the world really needs to, this package will
only support Python 3.X versions.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Fix documentation error (#16)

298ec60

This is a small patch to fix the examples in the docstrings.
Moreso, an index was also added to facilitate easier documentation.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Improve documentation (#16)

7b88430

This is a massive documentation update in order to make the
ReadTheDocs website as appealing it should be. In summary, the
following were undertaken:
  - Small patch fix for importing modules
  - Small modification in console_utils for console output
  - Modified ReadTheDocs' sidebar theme with an overriding css file.
  - Added a use-case example on Basic Optimization
  - Updated docstrings for most module implementations to make
    it look nice in the API documentation.

Even though most of these updates occured at different files,
they were all done for the sole purpose of improving documentation
in ReadTheDocs and introducing an API documentation at the end.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update example on training a neural network (#16)

53a54e6

This is an update to the previous commit regarding the documentation.
A use-case example for training a neural network is now implemented
as a Jupyter Notebook and as an .reST file in ReadTheDocs.

Also, a small stylistic change was done in asserting membership, if
we are to check if a certain key is in a dictionary, we now do the
following

  >>> if <set-of-keys> not in <required-set-of-keys>

Before, we are doing a `if not <set-of-keys> in`, which is
grammatically awkward. The new call sounds more natural and idiomatic.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update Python versions in CONTRIBUTING.rst (#16)

8d8bc83

Unless the world really needs to, this package will
only support Python 3.X versions.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Fix documentation error (#16)

b5389fb

This is a small patch to fix the examples in the docstrings.
Moreso, an index was also added to facilitate easier documentation.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Improve documentation (#16)

4d1c836

This is a massive documentation update in order to make the
ReadTheDocs website as appealing it should be. In summary, the
following were undertaken:
  - Small patch fix for importing modules
  - Small modification in console_utils for console output
  - Modified ReadTheDocs' sidebar theme with an overriding css file.
  - Added a use-case example on Basic Optimization
  - Updated docstrings for most module implementations to make
    it look nice in the API documentation.

Even though most of these updates occured at different files,
they were all done for the sole purpose of improving documentation
in ReadTheDocs and introducing an API documentation at the end.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update example on training a neural network (#16)

d0bf343

This is an update to the previous commit regarding the documentation.
A use-case example for training a neural network is now implemented
as a Jupyter Notebook and as an .reST file in ReadTheDocs.

Also, a small stylistic change was done in asserting membership, if
we are to check if a certain key is in a dictionary, we now do the
following

  >>> if <set-of-keys> not in <required-set-of-keys>

Before, we are doing a `if not <set-of-keys> in`, which is
grammatically awkward. The new call sounds more natural and idiomatic.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update Python versions in CONTRIBUTING.rst (#16)

621aabc

Unless the world really needs to, this package will
only support Python 3.X versions.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Fix documentation error (#16)

13f462b

This is a small patch to fix the examples in the docstrings.
Moreso, an index was also added to facilitate easier documentation.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Improve documentation (#16)

29bcb92

This is a massive documentation update in order to make the
ReadTheDocs website as appealing it should be. In summary, the
following were undertaken:
  - Small patch fix for importing modules
  - Small modification in console_utils for console output
  - Modified ReadTheDocs' sidebar theme with an overriding css file.
  - Added a use-case example on Basic Optimization
  - Updated docstrings for most module implementations to make
    it look nice in the API documentation.

Even though most of these updates occured at different files,
they were all done for the sole purpose of improving documentation
in ReadTheDocs and introducing an API documentation at the end.

Author: ljvmiranda921

ljvmiranda921 pushed a commit that referenced this issue


          Update example on training a neural network (#16)

1dd917a

This is an update to the previous commit regarding the documentation.
A use-case example for training a neural network is now implemented
as a Jupyter Notebook and as an .reST file in ReadTheDocs.

Also, a small stylistic change was done in asserting membership, if
we are to check if a certain key is in a dictionary, we now do the
following

  >>> if <set-of-keys> not in <required-set-of-keys>

Before, we are doing a `if not <set-of-keys> in`, which is
grammatically awkward. The new call sounds more natural and idiomatic.

Author: ljvmiranda921

msat59 mentioned this issue

Improving ftol_iter #449

Closed

2 tasks

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