question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Documentation fixes

See original GitHub issue

Documentation Task-List

  • RST file for Inverse Kinematics
  • Add citiation in the Pyramid topology to this paper
  • Use command style in the doc string’s “subject line”(PEP257)
  • Update documentation and docstrings using http://www.hemingwayapp.com/ (Readability ~Grade 9)
  • Merge (file merge, not git merge! 😆 ) basic_optimization example with **kwargs example (add RST file too)
  • Note on large boundaries, etc. (see #152)
  • Note on precision and overflow (see #152)
  • Note on creating custom-objective function (return value should be (n_particles) see #109 )
  • Update README (put Siobhan and Aaron as Collaborators).

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Comments:6 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
whzupcommented, Jul 6, 2018

What do you think about adding PEP257 conformity, @ljvmiranda921?

0reactions
whzupcommented, Jul 12, 2018

We should run flake8 once more before release 😄. Don’t know if this belongs here, though. I don’t know what some things do that flake8 wants to be changed so I’d rather give this to someone who knows what he’s doing there 😆.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Template: Bug Fixes Documentation List - OpenRegulatory
This list is used to document the evaluation and implementation of all bug fixes according to the company's change management process. Documentation of...
Read more >
How do we fix the state of technical documentation?
The answer comes in several degrees of intervention. The first and most obvious is to hire a professional to take care of it....
Read more >
Known Issues, Bug Fixes, and Documentation Issues
This chapter contains information about known issues, bug fixes, and documentation issues for Oracle Secure Global Desktop (SGD).
Read more >
Fixing your Documentation Problem - DEV Community ‍ ‍
As a bonus, start documenting every bigger post-mortem, describing how you discovered and fixed big problems at the project. This is a big...
Read more >
Does documentation and fixing belong in the Product Backlog?
The Product Backlog lists all features, functions, requirements, enhancements, and fixes that constitute the changes to be made to the product ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found