Skip to content
This repository has been archived by the owner on Sep 5, 2024. It is now read-only.

menu: $mdMenu service documentation does not exist #11610

Open
codymikol opened this issue Jan 24, 2019 · 1 comment · May be fixed by #11649
Open

menu: $mdMenu service documentation does not exist #11610

codymikol opened this issue Jan 24, 2019 · 1 comment · May be fixed by #11649
Assignees
@Splaktar
Labels
has: Pull Request A PR has been created to address this issue P3: important Important issues that really should be fixed when possible. type: docs
Milestone
- Backlog

Comments

@codymikol
Copy link
Contributor

Bug, enhancement request, or proposal: proposal

CodePen and steps to reproduce the issue:

CodePen Demo which demonstrates the issue: N/A

Detailed Reproduction Steps:

  1. Go to https://material.angularjs.org/latest/layout/introduction
  2. Notice no documentation for the $mdMenu service

What is the expected behavior?

There should be some documentation on how to use the service.

What is the current behavior?

The service is undocumented.

What is the use-case or motivation for changing an existing behavior?

Our team had some difficulty implementing a menu system and it would be much easier to work with if there was proper documentation.

Which versions of AngularJS, Material, OS, and browsers are affected?

  • AngularJS:
  • AngularJS Material: 1.1.12
  • OS:
  • Browsers:

Is there anything else we should know? Stack Traces, Screenshots, etc.

I may have some time to look into this, I'm sure it's not a very high priority as there are still quite a few P3+ issues.
@Splaktar
Copy link
Member

It's covered in https://material.angularjs.org/latest/api/directive/mdMenu, but I do agree that there should be something under SERVICES in the docs.

@Splaktar Splaktar changed the title $mdMenu documentation menu: $mdMenu service documentation does not exist Jan 28, 2019
@Splaktar Splaktar self-assigned this Jan 28, 2019
@Splaktar Splaktar added this to the 1.1.13 milestone Jan 28, 2019
@Splaktar Splaktar added the P3: important Important issues that really should be fixed when possible. label Jan 28, 2019
@Splaktar Splaktar modified the milestones: 1.1.13, 1.1.14 Feb 10, 2019
codymikol added a commit to codymikol/material that referenced this issue Feb 22, 2019
@codymikol
docs($mdMenu): add documentation for $mdMenu
65746b8 
currently there is no documentation.

Fixes: angular#11610
@codymikol codymikol linked a pull request Feb 22, 2019 that will close this issue
Open
3 tasks
@Splaktar Splaktar added the has: Pull Request A PR has been created to address this issue label Feb 26, 2019
@Splaktar Splaktar modified the milestones: 1.1.14, 1.1.15 Mar 18, 2019
@Splaktar Splaktar modified the milestones: 1.1.15, 1.1.16, 1.1.18, 1.1.19 Mar 29, 2019
@Splaktar Splaktar modified the milestones: 1.1.19, 1.1.20 May 30, 2019
@Splaktar Splaktar modified the milestones: 1.1.20, 1.1.21 Aug 15, 2019
codymikol added a commit to codymikol/material that referenced this issue Sep 12, 2019
@codymikol
docs($mdMenu): add documentation for $mdMenu
8325af7 
currently there is no documentation.

Fixes: angular#11610
@Splaktar Splaktar modified the milestones: 1.1.21, 1.1.22 Oct 22, 2019
@Splaktar Splaktar modified the milestones: 1.1.22, 1.1.23 Mar 6, 2020
@Splaktar Splaktar modified the milestones: 1.1.23, 1.2.1 May 6, 2020
@Splaktar Splaktar modified the milestones: 1.2.1, 1.2.2 Sep 14, 2020
@Splaktar Splaktar modified the milestones: 1.2.2, - Backlog Dec 16, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@Splaktar Splaktar

Labels
has: Pull Request A PR has been created to address this issue P3: important Important issues that really should be fixed when possible. type: docs
Projects
None yet
Milestone
- Backlog
Development

Successfully merging a pull request may close this issue.

docs($mdMenu): add documentation for $mdMenu codymikol/material
2 participants
@Splaktar @codymikol