Skip to content

Conversation

@emlaver
Copy link
Contributor

@emlaver emlaver commented Oct 21, 2021

PR summary

Fixes: #49

Note: An existing issue is required before opening a PR.

PR Checklist

Please make sure that your PR fulfills the following requirements:

  • The commit message follows the
    Angular Commit Message Guidelines.
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • New tests
  • Build/CI related changes
  • Documentation content changes
  • Other (please describe)

What is the current behavior?

Custom common, version, and cloudant_base_service exist in the documentation. The user does not need to interact with these modules and they can be excluded in the docs.

What is the new behavior?

Custom modules common, version, and cloudant_base_service removed in docs.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@emlaver emlaver self-assigned this Oct 21, 2021
Copy link
Contributor

@eiri eiri left a comment

Choose a reason for hiding this comment

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

Seems legit according to sphinx-apidoc man.

Is there a generated result to check how it looks like or we'll only see this after merge?

@emlaver
Copy link
Contributor Author

emlaver commented Oct 22, 2021

This is what apidocs/modules.html looks like locally:
Screen Shot 2021-10-21 at 11 22 51 PM

Copy link
Contributor

@mojito317 mojito317 left a comment

Choose a reason for hiding this comment

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

Wdyt about couchdb_session_get_authenticator_patch? Users should not interact with that too, right?

@emlaver
Copy link
Contributor Author

emlaver commented Nov 8, 2021

Wdyt about couchdb_session_get_authenticator_patch? Users should not interact with that too, right?

Yes you're right, I'll remove that too.

Copy link
Contributor

@mojito317 mojito317 left a comment

Choose a reason for hiding this comment

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

lgtm! please use Angular Commit Message when you squash.

@emlaver emlaver force-pushed the 49-remove-docstring-to-custom-files branch from 1d44542 to 20fbbf7 Compare November 9, 2021 15:20
@emlaver emlaver merged commit 3149319 into master Nov 10, 2021
@emlaver emlaver deleted the 49-remove-docstring-to-custom-files branch November 10, 2021 20:00
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.

Add docstring to custom files and functions

4 participants