Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Docs audit #22

Merged
merged 1 commit into from
May 21, 2019
Merged

Docs audit #22

merged 1 commit into from
May 21, 2019

Conversation

bmorcos
Copy link
Contributor

@bmorcos bmorcos commented May 14, 2019 •
edited
Loading

Motivation and context:

Reviewing all doc sets for consistency:

  • Add nitpicky = True to conf.py
  • Changed 'dna' to 'id' in gitignore
  • Update setup.py to use version file, remove requirements.txt
  • Using NengoFPGA in changelog, and fixed PR number
  • Using NengoFPGA instead of Nengo FPGA everywhere
  • Removed single backticks. Using code formating for files/paths and bold for
    names, etc.
  • Using support@appliedbrainresearch.com
  • Now using 'code-block::' for everything
  • Expanded ABR, info, and docs to full words
  • Full capitalized level 1-2 headers

How long should this take to review?

  • Average (neither quick nor lengthy)

Where should a reviewer start?

Build the docs and take a read through.

Types of changes:

  • Non-code change (touches things like tests, documentation, build scripts)

Checklist:

  • I have read the CONTRIBUTING.rst document.
  • I have updated the documentation accordingly.
  • I have included a changelog entry.
  • N/A I have tested this with all supported devices.
  • N/A I have added tests to cover my changes.
  • N/A I have run the test suite locally and all tests passed.

xchoo
xchoo requested changes May 20, 2019
View reviewed changes
Copy link
Member

@xchoo xchoo left a comment

Choose a reason for hiding this comment

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

Minor changes and corrections.

@bmorcos
Docs audit for consistency
6b5edd1 
- Add nitpicky = True to conf.py
- Changed 'dna' to 'id' in gitignore
- Update setup.py to use version file, remove requirements.txt
- Using NengoFPGA in changelog, and fixed PR number
- Using NengoFPGA instead of Nengo FPGA everywhere
- Removed single backticks. Using code formating for files/paths and bold for
  names, etc.
- Using support@appliedbrainresearch.com
- Now using 'code-block::' for everything
- Expanded ABR, info, and docs to full words
- Full capitalized level 1-2 headers
- Bolster setup.py with stuff from nengo
@bmorcos bmorcos merged commit 6b5edd1 into master May 21, 2019
@bmorcos bmorcos deleted the docs-audit branch May 21, 2019 17:24
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@xchoo xchoo xchoo approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bmorcos @xchoo